Commit 38c2074b authored by Jesse Mapel's avatar Jesse Mapel
Browse files

Fixed ControlPointV#### class docs

parent 631ef4a7

isis/src/control/objs/ControlNetVersioner/ControlPointV0001.cpp

+3 −3
Original line number Diff line number Diff line
@@ -594,7 +594,7 @@ namespace Isis { 
   * @param container The PvlContainer representation of the control point that contains the

   *                  PvlKeyword.

   * @param keyName The name of the keyword to be copied.

   * @param point[out] The version 1 protobuf representation of the control point that the value

   * @param[out] point The version 1 protobuf representation of the control point that the value

   *                   will be copied into.

   * @param setter The protobuf mutator method that sets the value of the field in the protobuf

   *               representation.
@@ -625,7 +625,7 @@ namespace Isis { 
   * @param container The PvlContainer representation of the control point that contains the

   *                  PvlKeyword.

   * @param keyName The name of the keyword to be copied.

   * @param point[out] The version 1 protobuf representation of the control point that the value

   * @param[out] point The version 1 protobuf representation of the control point that the value

   *                   will be copied into.

   * @param setter The protobuf mutator method that sets the value of the field in the protobuf

   *               representation.
@@ -653,7 +653,7 @@ namespace Isis { 
   * @param container The PvlContainer representation of the control point that contains the

   *                  PvlKeyword.

   * @param keyName The name of the keyword to be copied.

   * @param point[out] The version 1 protobuf representation of the control point that the value

   * @param[out] point The version 1 protobuf representation of the control point that the value

   *                   will be copied into.

   * @param setter The protobuf mutator method that sets the value of the field in the protobuf

   *               representation.

isis/src/control/objs/ControlNetVersioner/ControlPointV0001.h

+15 −1
Original line number Diff line number Diff line
@@ -76,9 +76,23 @@ namespace Isis { 
      QSharedPointer<ControlNetLogDataProtoV0001_Point> logData();



    private:

      // These are intentionally not implemented

      /**

       * Default constructor. Intentionally un-implemented.

       */

      ControlPointV0001();

      /**

       * Copy constructor. Intentionally un-implemented.

       *

       * @param other The other ControlPointV0001 to copy from.

       */

      ControlPointV0001(const ControlPointV0001 &other);

      /**

       * Assignment operator. Intentionally un-implemented.

       *

       * @param other The other ControlPointV0001 to assign from.

       *

       * @return @b ControlPointV0001& A reference to this after assignment.

       */

      ControlPointV0001 &operator=(const ControlPointV0001 &other);



      // methods for converting from Pvl to protobuf

isis/src/control/objs/ControlNetVersioner/ControlPointV0002.cpp

+3 −3
Original line number Diff line number Diff line
@@ -358,7 +358,7 @@ namespace Isis { 
   * @param container The PvlContainer representation of the control point that contains the

   *                  PvlKeyword.

   * @param keyName The name of the keyword to be copied.

   * @param point[out] The version 1 protobuf representation of the control point that the value

   * @param[out] point The version 1 protobuf representation of the control point that the value

   *                   will be copied into.

   * @param setter The protobuf mutator method that sets the value of the field in the protobuf

   *               representation.
@@ -389,7 +389,7 @@ namespace Isis { 
   * @param container The PvlContainer representation of the control point that contains the

   *                  PvlKeyword.

   * @param keyName The name of the keyword to be copied.

   * @param point[out] The version 1 protobuf representation of the control point that the value

   * @param[out] point The version 1 protobuf representation of the control point that the value

   *                   will be copied into.

   * @param setter The protobuf mutator method that sets the value of the field in the protobuf

   *               representation.
@@ -417,7 +417,7 @@ namespace Isis { 
   * @param container The PvlContainer representation of the control point that contains the

   *                  PvlKeyword.

   * @param keyName The name of the keyword to be copied.

   * @param point[out] The version 1 protobuf representation of the control point that the value

   * @param[out] point The version 1 protobuf representation of the control point that the value

   *                   will be copied into.

   * @param setter The protobuf mutator method that sets the value of the field in the protobuf

   *               representation.

isis/src/control/objs/ControlNetVersioner/ControlPointV0002.h

+15 −1
Original line number Diff line number Diff line
@@ -176,9 +176,23 @@ namespace Isis { 
      QSharedPointer<ControlNetLogDataProtoV0001_Point> logData();



    private:

      // These are intentionally not implemented

      /**

       * Default constructor. Intentionally un-implemented.

       */

      ControlPointV0002();

      /**

       * Copy constructor. Intentionally un-implemented.

       *

       * @param other The other ControlPointV0002 to copy from.

       */

      ControlPointV0002(const ControlPointV0002 &other);

      /**

       * Assignment operator. Intentionally un-implemented.

       *

       * @param other The other ControlPointV0002 to assign from.

       *

       * @return @b ControlPointV0002& A reference to this after assignment.

       */

      ControlPointV0002 &operator=(const ControlPointV0002 &other);



      // methods for converting from Pvl to protobuf

isis/src/control/objs/ControlNetVersioner/ControlPointV0003.cpp

+3 −3
Original line number Diff line number Diff line
@@ -569,7 +569,7 @@ namespace Isis { 
   * @param container The PvlContainer representation of the control point that contains the

   *                  PvlKeyword.

   * @param keyName The name of the keyword to be copied.

   * @param point[out] The version 2 protobuf representation of the control point that the value

   * @param[out] point The version 2 protobuf representation of the control point that the value

   *                   will be copied into.

   * @param setter The protobuf mutator method that sets the value of the field in the protobuf

   *               representation.
@@ -601,7 +601,7 @@ namespace Isis { 
   * @param container The PvlContainer representation of the control point that contains the

   *                  PvlKeyword.

   * @param keyName The name of the keyword to be copied.

   * @param point[out] The version 2 protobuf representation of the control point that the value

   * @param[out] point The version 2 protobuf representation of the control point that the value

   *                   will be copied into.

   * @param setter The protobuf mutator method that sets the value of the field in the protobuf

   *               representation.
@@ -630,7 +630,7 @@ namespace Isis { 
   * @param container The PvlContainer representation of the control point that contains the

   *                  PvlKeyword.

   * @param keyName The name of the keyword to be copied.

   * @param point[out] The version 2 protobuf representation of the control point that the value

   * @param[out] point The version 2 protobuf representation of the control point that the value

   *                   will be copied into.

   * @param setter The protobuf mutator method that sets the value of the field in the protobuf

   *               representation.