Fixed documentation typos in ControlNetVersioner (631ef4a7) · Commits · aflab / astrogeology / ISIS3

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

+5 −2

Original line number	Diff line number	Diff line
		@@ -150,7 +150,7 @@ namespace Isis {
		/**
		* Returns the name of the last person or program to modify the network.
		*
		* @retrun @b QString The name of the last person or program to modify the network.
		* @return @b QString The name of the last person or program to modify the network.
		*/
		QString ControlNetVersioner::userName() const {
		return m_header.userName;
		@@ -912,6 +912,7 @@ namespace Isis {
		* Read a protobuf version 1 control network and prepare the data to be
		* converted into a control network.
		*
		* @param header The Pvl file header that contains byte offsets for the protobuf messages
		* @param netFile The filename of the control network file.
		* @param progress The progress object to track reading points.
		*/
		@@ -1032,6 +1033,7 @@ namespace Isis {
		* Read a protobuf version 2 control network and prepare the data to be
		* converted into a control network.
		*
		* @param header The Pvl file header that contains byte offsets for the protobuf messages
		* @param netFile The filename of the control network file.
		* @param progress The progress object to track reading points.
		*/
		@@ -1148,6 +1150,7 @@ namespace Isis {
		* Read a protobuf version 5 control network and prepare the data to be
		* converted into a control network.
		*
		* @param header The Pvl file header that contains byte offsets for the protobuf messages
		* @param netFile The filename of the control network file.
		* @param progress The progress object to track reading points.
		*/
		@@ -1776,7 +1779,7 @@ namespace Isis {
		* The written point will be removed from the versioner and deleted if the versioner
		* has ownership of it.
		*
		* @param fileStream A pointer to the fileStream that we are writing the point to.
		* @param output A pointer to the fileStream that we are writing the point to.
		*
		* @return @b int The number of bytes written to the filestream.
		*/

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

+14 −1

Original line number	Diff line number	Diff line
		@@ -388,7 +388,7 @@ namespace Isis {
		* @history 2017-12-18 Adam Goins and Kristin Berry - Added new write() method.
		* @history 2017-12-19 Kristin Berry - Corrected method names and general cleanup in toPvl and
		* write for refactor.
		* @histroy 2017-12-20 Jesse Mapel - Made read and createPoint methods match new
		* @history 2017-12-20 Jesse Mapel - Made read and createPoint methods match new
		* ControlPointV#### classes.
		* @history 2017-12-20 Jeannie Backer - Updated toPvl and write methods to get surface point
		* information from the ControlPoint.
		@@ -424,8 +424,21 @@ namespace Isis {
		private:
		// These three methods are private for safety reasons.
		// TODO write a better reason. JAM
		//! Default constructor. Intentially un-implemented.
		ControlNetVersioner();
		/**
		* Copy constructor. Intentially un-implemented.
		*
		* @param other The other ControlNetVersioner to create a copy of.
		*/
		ControlNetVersioner(const ControlNetVersioner &other);
		/**
		* Asssignment operator. Intentially un-implemented.
		*
		* @param other The other ControlNetVersione to assign from.
		*
		* @return @b ControlNetVersioner& A reference to this after assignment.
		*/
		ControlNetVersioner &operator=(const ControlNetVersioner &other);

		// Private ControlNetHeader structs for versioning