Added documentation to comply with Isis standards. (6b36e8bb) · Commits · aflab / astrogeology / ISIS3

isis/src/qisis/objs/Directory/SetActiveControlWorkOrder.cpp

+12 −11

Original line number	Diff line number	Diff line
		@@ -33,7 +33,7 @@
		namespace Isis {

		/**
		* @brief Creates a WorkOrder that will set the active Control in the project.
		* @description Creates a WorkOrder that will set the active Control in the project.
		* @param project The Project that this work order should be interacting with.
		*/
		SetActiveControlWorkOrder::SetActiveControlWorkOrder(Project *project) :
		@@ -48,7 +48,7 @@ namespace Isis {


		/**
		* @brief Copies the 'other' WorkOrdeer instance into this new instance.
		* @description Copies the 'other' WorkOrder instance into this new instance.
		* @param other The WorkOrder being copied.
		*/
		SetActiveControlWorkOrder::SetActiveControlWorkOrder(const SetActiveControlWorkOrder &other) :
		@@ -57,14 +57,14 @@ namespace Isis {


		/**
		* @brief The Destructor.
		* @description The Destructor.
		*/
		SetActiveControlWorkOrder::~SetActiveControlWorkOrder() {
		}


		/**
		* @brief Returns a copy of this SetActiveControlWorkOrder instance.
		* @description Returns a copy of this SetActiveControlWorkOrder instance.
		* @return @b (SetActiveControlWorkOrder *) A pointer to a copy of this WorkOrder.
		*/
		SetActiveControlWorkOrder *SetActiveControlWorkOrder::clone() const {
		@@ -73,9 +73,9 @@ namespace Isis {


		/**
		* @brief Determines if we can set this control as active.
		* @description Determines if we can set this control as active.
		*
		* @param Control *control
		* @param controls (ControlList *) The ControlList chosen from the project tree.
		* @return @b bool True if we can set as active, False otherwise.
		*/
		bool SetActiveControlWorkOrder::isExecutable(ControlList *controls) {
		@@ -88,7 +88,7 @@ namespace Isis {


		/**
		* @desc Make sure an active ImageList has been chosen.
		* @description Make sure an active ImageList has been chosen.
		*
		* @return @b bool True if project has an active ImageList, False otherwise.
		*/
		@@ -115,9 +115,10 @@ namespace Isis {


		/**
		* @desc Set the active control net for the project. This allows any views to operate on the
		* same control net. The active image list must be set before the active control net is
		* chosen. If not, a critical message dialog is displayed and we return false.
		* @description Set the active control net for the project. This allows any views to operate on
		* the same control net. The active image list must be set before the active
		* control net is chosen. If not, a critical message dialog is displayed and we
		* return false.
		*
		*/
		void SetActiveControlWorkOrder::execute() {

isis/src/qisis/objs/Directory/SetActiveControlWorkOrder.h

+3 −1

Original line number	Diff line number	Diff line
		@@ -38,7 +38,9 @@ namespace Isis {
		* @history 2017-01-09 Tracie Sucharski - Moved the SetImages step to the
		* Project::setActiveControl.
		* @history 2017-01-30 Tracie Sucharski - Print active control in the Undo text.
		* 2017-04-04 Tracie Sucharski - Updated to reflect the new WorkOrder design.
		* 2017-04-04 Tracie Sucharski - Updated to reflect the new WorkOrder design, renaming
		* execute to setupExecution, and moving the actual work to execute.
		* Fixes #4717, #4728.
		*/

		class SetActiveControlWorkOrder : public WorkOrder {