Commit ed837073 authored by Makayla Shepherd's avatar Makayla Shepherd
Browse files

Added documentation to WorkOrderFactory. Fixes #3957. 

git-svn-id: http://subversion.wr.usgs.gov/repos/prog/isis3/branches/ipce@6818 41f8697f-d340-4b68-9986-7bafba869bb8
parent 1bd75aa6

isis/src/qisis/objs/WorkOrder/WorkOrderFactory.cpp

+4 −0
Original line number Diff line number Diff line
@@ -32,6 +32,10 @@ namespace Isis { 
   *

   * @param project The project to give to the work order constructor

   * @param type The work order type (class name) - for example "Isis::ImportImagesWorkOrder"

   * 

   * @throws IException::Unknown "Could not create the work order through WorkOrderFactory"

   * 

   * @return @b WorkOrder Returns the instantiated WorkOrder

   */

  WorkOrder *WorkOrderFactory::create(Project *project, QString type) {

    WorkOrder *result = NULL;

isis/src/qisis/objs/WorkOrder/WorkOrderFactory.h

+3 −2
Original line number Diff line number Diff line
@@ -44,8 +44,9 @@ namespace Isis { 
   *                         mistakes and to reduce duplicate code.

   *   @history 2014-07-14 Kimberly Oyama - Added support for correlation matrix.

   *   @history 2015-08-14 Jeannie Backer - Added jigsaw work order.

   *   @history 2016-06-14 Jesse Mapel - Removed include and tryType for CubeViewportViewWorkOrder.

   *                           Fixes #3953.

   *   @history 2015-09-05 Ken Edmundson - Added support for new WorkOrders: SaveProjectWorkOrder,

   *                         SensorGetInforWorkOrder, and TargetGetInfoWorkOrder.

   *   @history 2016-06-09 Makayla Shepherd - Updated documentation. Fixes #3957.

   */

  class WorkOrderFactory {

    public: