Changeset 9688 for trunk/psModules/src/concepts/pmConcepts.h

Timestamp:

Oct 20, 2006, 2:55:44 PM (20 years ago)

Author:

Paul Price

Message:

Adding a little bit more detail to the comments.

File:

• trunk/psModules/src/concepts/pmConcepts.h (modified) (2 diffs)

trunk/psModules/src/concepts/pmConcepts.h

@@ -7 +7 @@
 /// @author Paul Price, IfA
 ///
-/// @version $Revision: 1.8 $ $Name: not supported by cvs2svn $
-/// @date $Date: 2006-10-17 00:33:56 $
+/// @version $Revision: 1.9 $ $Name: not supported by cvs2svn $
+/// @date $Date: 2006-10-21 00:55:44 $
 ///
 /// Copyright 2005-2006 Institute for Astronomy, University of Hawaii
@@ -59 +59 @@
 ///
 /// Defines a new concept, based on the blank value (with name and default comment), and functions to parse
-/// and format the concept.  The new concept is registered at the specified level (FPA, chip or cell).
+/// and format the concept.  The new concept is registered at the specified level (FPA, chip or cell).  If the
+/// parse function is NULL, then a default parse function is used, which performs minimal parsing.  Similarly
+/// for the format function.
 bool pmConceptRegister(psMetadataItem *blank, ///< Blank value; contains the name and default comment
-                       pmConceptParseFunc parse, ///< Function to call to parse the concept
-                       pmConceptFormatFunc format, ///< Function to call to format the concept
+                       pmConceptParseFunc parse, ///< Function to call to parse the concept, or NULL
+                       pmConceptFormatFunc format, ///< Function to call to format the concept, or NULL
                        pmFPALevel level ///< Level at which to store concept in the FPA hierarchy
                       );