Commit 497d1ed1 authored by John Bonn's avatar John Bonn
Browse files

changed invalid @description tags to @brief.

parent e93921fd
Loading
Loading
Loading
Loading
+4 −2
Original line number Diff line number Diff line
@@ -35,7 +35,8 @@ namespace Isis {


/**
 * @description Load required NAIF kernels required for timing needs.
 * @brief Load required NAIF kernels required for timing needs.
 *
 * This method maintains the loading of kernels for HAYABUSA timing and
 * planetary body ephemerides to support time and relative positions of planet
 * bodies.
@@ -80,7 +81,8 @@ static void loadNaifTiming() {


/**
 * @description Computes the distance from the Sun to the observed body.
 * @brief Computes the distance from the Sun to the observed body.
 *
 * This method requires the appropriate NAIK kernels to be loaded that
 * provides instrument time support, leap seconds and planet body ephemeris.
 * @return @b double Distance in AU between Sun and observed body.
+5 −9
Original line number Diff line number Diff line
/**
 * @file
 * $Revision: 1.19 $
 * $Date: 2010/03/22 19:44:53 $
 *
 *   Unless noted otherwise, the portions of Isis written by the USGS are
 *   public domain. See individual third-party library and package descriptions
@@ -95,7 +93,7 @@ namespace Isis {
  }
  
  /**
   * @description This method returns false because this WorkOrder is not undoable.
   * @brief This method returns false because this WorkOrder is not undoable.
   * 
   * @see WorkOrder::isUndoable()
   * 
@@ -107,10 +105,9 @@ namespace Isis {

  
  /**
   * @description This method asks the user what view they want to see their cube list in. The user 
   * @brief This method asks the user what view they want to see their cube list in. The user 
   * can select an existing vew or they can create a new view. The user's choice is then saved using 
   * setInternalData(). This method was renamed from execute() to setupExecution() according to the 
   * WorkOrder redesign.
   * setInternalData(). 
   * 
   * @see WorkOrder::setupExecution()
   * 
@@ -165,9 +162,8 @@ namespace Isis {


  /**
   * @description This method adds a new CubeDnView to the project's directory and then adds 
   * currentItem() to that. This method was renamed from syncRedo() to execute() according to 
   * WorkOrder's redesign. 
   * @brief This method adds a new CubeDnView to the project's directory and then adds 
   * currentItem() to that. 
   */
  void CubeDnViewWorkOrder::execute() {
    QList<ProjectItem *> selectedItems = project()->directory()->model()->selectedItems();
+5 −7
Original line number Diff line number Diff line
@@ -57,7 +57,7 @@ namespace Isis {
  
  
  /**
   * @description This method returns false because this WorkOrder is not undoable.
   * @brief This method returns false because this WorkOrder is not undoable.
   * 
   * @see WorkOrder::isUndoable()
   * 
@@ -69,10 +69,9 @@ namespace Isis {

  
  /**
   * @description This method asks the user what view they want to see their image list in. The user 
   * @brief This method asks the user what view they want to see their image list in. The user 
   * can select an existing view or they can create a new view. The user's choice is then saved 
   * using setInternalData(). This method was renamed from execute() to setupExecution() according  
   * to the WorkOrder redesign.
   * using setInternalData(). 
   * 
   * @see WorkOrder::setupExecution()
   * 
@@ -137,9 +136,8 @@ namespace Isis {

  
  /**
   * @description This method adds a new image file list to the project's directory and then adds 
   * currentItem() to that. This method was renamed from syncRedo() to execute() according to 
   * WorkOrder's redesign. 
   * @brief This method adds a new image file list to the project's directory and then adds 
   * currentItem() to that. 
   */
  void ImageFileListViewWorkOrder::execute() {
    int viewToUse = internalData().first().toInt();
+3 −7
Original line number Diff line number Diff line
/**
 * @file
 * $Revision: 1.19 $
 * $Date: 2010/03/22 19:44:53 $
 *
 *   Unless noted otherwise, the portions of Isis written by the USGS are
 *   public domain. See individual third-party library and package descriptions
@@ -147,7 +145,7 @@ namespace Isis {

  
  /**
   * This method returns true if other depends on a MatrixViewWorkOrder
   * @brief This method returns true if other depends on a MatrixViewWorkOrder
   * 
   * @param other we want to check for dependancies
   * 
@@ -161,8 +159,7 @@ namespace Isis {
  

  /**
   * @description This method computes and displays the correlation matrix. This was renamed from
   * syncRedo() to execute() according to the WorkOrder redesign.
   * @brief This method computes and displays the correlation matrix. 
   */
  void MatrixViewWorkOrder::execute() {
    MatrixSceneWidget *matrixViewToUse = project()->directory()->addMatrixView();
@@ -183,8 +180,7 @@ namespace Isis {

  
  /**
   * @description This method deletes the last matrix viewed. This was renamed from syncUndo() to
   * execute() according to the WorkOrder redesign.
   * @brief This method deletes the last matrix viewed. 
   */
  void MatrixViewWorkOrder::undoExecution() {
    if (internalData()[1] == "new view") {
+1 −1
Original line number Diff line number Diff line
@@ -34,7 +34,7 @@ namespace Isis {
  class FileName;

  /**
   * @description Saves a project to disk (File->Save Project As...)
   * @brief Saves a project to disk (File->Save Project As...)
   *
   * @author 2012-??-?? ???
   *
Loading