FluxSvc Comments

Documentation

Mainpage

• Insert link to release.notes.
• Add in section to discuss jobOptions parameters:
  * @section jobOptions jobOptions
  * @param ExampleAlg.property 
  *   an example input integer parameter for a user-defined Gaudi algorithm
  *   default value zero 0
  * @param ExampleSvc.property
  *   an example input integer parameter for a user-defined Gaudi service
  Explicitly demonstrate loading a user defined source library in the jobOptions file.

General

• All classes need our standard Doxygen class header before the class declaration:
  /**
   * @class ClassTemplate
   *
   * @brief This is an example class.
   *
   * This comment block is @e required for all classes.
   * If you desire to provide a link to a web page do  
   * <A HREF="http://www-glast.slac.stanford.edu/software" GLAST Home Page</A>
   *
   * @author Some Body
   *   
   * $Header$
   */
  Sean Robinson's Orbit class does contain a nice summary in the header file.  All of Pat Nolen's classes:  AlbedoPSpectrum, CHIMESpectrum, HeSpectrum... have great summaries in their header files.  This documentation just needs to be put into our standard form.
• All source files should include the standard GLAST comment block at the beginning of the file:
  // File and Version Information:
  //      $Header$
  //
  // Description:
  //      ClassTemplate provides an example of code documentation for a class.  These comments
  //      will not be processed by Doxygen - but are here for Developers to identify this source
  //      file.
  //
  // Author(s):
  //      Author1                       
  //      Author2                       
• All methods should include the standard GLAST comment block in their definition:
    // Purpose and Method:  [include the physics if appropriate]
    // Inputs
    // Outputs
    // TDS Inputs
    // TDS Outputs
    // Dependencies:
    // Restrictions and Caveats:  e.g. "This doesn't work off-axis"

• Use whitespace rather than divider lines.

• Images should be stored in a doc/images directory.

• Do not bother to comment obvious methods...such as: // constructor

Provide links to external documentation on models - such as CHIME...

A list of accepted particle names should be documented.

Document all standard sources provided in the source_library file.

What is the purpose of the defaultOptions.txt file - are users supposed to include it?

Provide additional details about using the Tool structure for an externally defined spectrum.
Mention the need to provide additional XML definitions for the new sources.

Code

Validation Plans

Are there any deprecated methods in some of these classes?  EventSource::eventNumber( )?

What is Flux::numSource( ) for?

What is the status of the TimeDepSpectrum class?

FluxSvc_dll.cxx and FluxSvc_load.cxx need to use the new Gaudi macros.
http://www-glast.slac.stanford.edu/software/gaudi/gaudi_v9/details.htm#Shareable

Are there plans to remove the use of strstream in favor of sstream?

H. Kelly Last Modified:  2004-08-04 15:40:42 -0700