Revision: 13063
http://sbml.svn.sourceforge.net/sbml/?rev=13063&view=rev
Author: mhucka
Date: 2011-02-27 05:16:27 +0000 (Sun, 27 Feb 2011)
Log Message:
-----------
Improved handling of conditional documentation sections
for different languages. Now using @else inside @if...@..., after having
modified swigdoc.py to make it work.
Modified Paths:
--------------
trunk/libsbml/src/annotation/CVTerm.h
trunk/libsbml/src/annotation/RDFAnnotation.h
trunk/libsbml/src/math/ASTNode.h
trunk/libsbml/src/math/FormulaFormatter.h
trunk/libsbml/src/math/FormulaParser.h
trunk/libsbml/src/sbml/Compartment.h
trunk/libsbml/src/sbml/CompartmentType.h
trunk/libsbml/src/sbml/InitialAssignment.h
trunk/libsbml/src/sbml/KineticLaw.h
trunk/libsbml/src/sbml/LocalParameter.h
trunk/libsbml/src/sbml/Model.h
trunk/libsbml/src/sbml/Parameter.h
trunk/libsbml/src/sbml/Rule.h
trunk/libsbml/src/sbml/SBMLDocument.h
trunk/libsbml/src/sbml/SBMLError.h
trunk/libsbml/src/sbml/SBMLErrorLog.h
trunk/libsbml/src/sbml/SBMLNamespaces.h
trunk/libsbml/src/sbml/SBMLReader.h
trunk/libsbml/src/sbml/SBMLWriter.h
trunk/libsbml/src/sbml/SBase.h
trunk/libsbml/src/sbml/Species.h
trunk/libsbml/src/sbml/SpeciesReference.h
trunk/libsbml/src/sbml/SpeciesType.h
trunk/libsbml/src/sbml/Unit.h
trunk/libsbml/src/sbml/UnitDefinition.h
trunk/libsbml/src/xml/XMLError.h
trunk/libsbml/src/xml/XMLErrorLog.h
trunk/libsbml/src/xml/XMLNamespaces.h
trunk/libsbml/src/xml/XMLNode.h
trunk/libsbml/src/xml/XMLToken.h
Modified: trunk/libsbml/src/annotation/CVTerm.h
===================================================================
--- trunk/libsbml/src/annotation/CVTerm.h 2011-02-27 05:14:17 UTC (rev 13062)
+++ trunk/libsbml/src/annotation/CVTerm.h 2011-02-27 05:16:27 UTC (rev 13063)
@@ -55,34 +55,34 @@
* such as Species, Compartment, etc. The following template illustrates
* the different parts of SBML annotations in XML form:
*
-<div class="fragment">
-<<span style="background-color: #bbb">SBML_ELEMENT</span> <span style="background-color: #d0eed0">+++</span> metaid="<span style="border-bottom: 1px solid black">meta id</span>" <span style="background-color: #d0eed0">+++</span>><br>
- <span style="background-color: #d0eed0">+++</span><br>
- <annotation><br>
- <span style="background-color: #d0eed0">+++</span><br>
- <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"<br>
- xmlns:dc="http://purl.org/dc/elements/1.1/"<br>
- xmlns:dcterm="http://purl.org/dc/terms/"<br>
- xmlns:vcard="http://www.w3.org/2001/vcard-rdf/3.0#"<br>
- xmlns:bqbiol="http://biomodels.net/biology-qualifiers/"<br>
- xmlns:bqmodel="http://biomodels.net/model-qualifiers/" ><br>
- <rdf:Description rdf:about="#<span style="border-bottom: 1px solid black">meta id</span>"><br>
- <span style="background-color: #ddd; border-bottom: 2px dotted #888">HISTORY</span><br>
- <<span style="background-color: #bbb">RELATION_ELEMENT</span>><br>
- <rdf:Bag><br>
- <rdf:li rdf:resource="<span style="background-color: #d0d0ee">URI</span>" /><br>
- <span style="background-color: #edd">...</span><br>
- </rdf:Bag><br>
- </<span style="background-color: #bbb">RELATION_ELEMENT</span>><br>
- <span style="background-color: #edd">...</span><br>
- </rdf:Description><br>
- <span style="background-color: #d0eed0">+++</span><br>
- </rdf:RDF><br>
- <span style="background-color: #d0eed0">+++</span><br>
- </annotation><br>
- <span style="background-color: #d0eed0">+++</span><br>
-</<span style="background-color: #bbb">SBML_ELEMENT</span>><br>
-</div>
+ <div class="fragment">
+ <<span style="background-color: #bbb">SBML_ELEMENT</span> <span style="background-color: #d0eed0">+++</span> metaid="<span style="border-bottom: 1px solid black">meta id</span>" <span style="background-color: #d0eed0">+++</span>><br>
+ <span style="background-color: #d0eed0">+++</span><br>
+ <annotation><br>
+ <span style="background-color: #d0eed0">+++</span><br>
+ <rdf:RDF xmlns:rdf="http://www.w3.org/1999/02/22-rdf-syntax-ns#"<br>
+ xmlns:dc="http://purl.org/dc/elements/1.1/"<br>
+ xmlns:dcterm="http://purl.org/dc/terms/"<br>
+ xmlns:vcard="http://www.w3.org/2001/vcard-rdf/3.0#"<br>
+ xmlns:bqbiol="http://biomodels.net/biology-qualifiers/"<br>
+ xmlns:bqmodel="http://biomodels.net/model-qualifiers/" ><br>
+ <rdf:Description rdf:about="#<span style="border-bottom: 1px solid black">meta id</span>"><br>
+ <span style="background-color: #e0e0e0; border-bottom: 2px dotted #888">HISTORY</span><br>
+ <<span style="background-color: #bbb">RELATION_ELEMENT</span>><br>
+ <rdf:Bag><br>
+ <rdf:li rdf:resource="<span style="background-color: #d0d0ee">URI</span>" /><br>
+ <span style="background-color: #edd">...</span><br>
+ </rdf:Bag><br>
+ </<span style="background-color: #bbb">RELATION_ELEMENT</span>><br>
+ <span style="background-color: #edd">...</span><br>
+ </rdf:Description><br>
+ <span style="background-color: #d0eed0">+++</span><br>
+ </rdf:RDF><br>
+ <span style="background-color: #d0eed0">+++</span><br>
+ </annotation><br>
+ <span style="background-color: #d0eed0">+++</span><br>
+ </<span style="background-color: #bbb">SBML_ELEMENT</span>><br>
+ </div>
*
* In the template above, the placeholder
* <span class="code" style="background-color: #bbb">SBML_ELEMENT</span> stands for
@@ -99,7 +99,7 @@
* <span class="code" style="background-color: #edd">...</span>
* are placeholders for zero or more elements of the same form as the
* immediately preceding element. The optional content
- * <span class="code" style="background-color: #ddd; border-bottom: 2px dotted #888">HISTORY</span>
+ * <span class="code" style="background-color: #e0e0e0; border-bottom: 2px dotted #888">HISTORY</span>
* is a creation and modification history; in libSBML, this is stored
* using ModelHistory objects.
*
@@ -226,8 +226,7 @@
/**
* Creates an empty CVTerm, optionally with the given
- * @if clike #QualifierType_t@... java qualifier type code@... value
- * @p type.
+ * @if clike #QualifierType_t value@... qualifier@... @p type.
*
* The SBML Level 2 and Level 3 specifications define a simple
* format for annotating models when (a) referring to controlled
@@ -253,8 +252,8 @@
* an explicit value for @p type is not given, this method defaults to
* using @link QualifierType_t#UNKNOWN_QUALIFIER
* UNKNOWN_QUALIFIER@.... The
- * @if clike #QualifierType_t@... java qualifier type code@...
- * type value can be set later using the
+ * @if clike #QualifierType_t value@... qualifier type@...
+ * can be set later using the
* CVTerm::setQualifierType(@if java int type@...) method.
*
* Different BioModels.net qualifier elements encode different types of
@@ -263,7 +262,7 @@
* qualifiers web page</a> for an explanation of the meaning of these
* different qualifiers.
*
- * @param type a @if clike #QualifierType_t@... java qualifier type code@... value
+ * @param type a @if clike #QualifierType_t value@... qualifier type@...
*
* @if notcpp @docnote @htmlinclude warn-default-args-in-docs.html @endif
*/
@@ -337,7 +336,7 @@
/**
- * Returns the qualifier type code for this CVTerm object.
+ * Returns the qualifier type of this CVTerm object.
*
* @htmlinclude cvterm-common-description-text.html
*
@@ -363,8 +362,8 @@
* the @em other two methods to call to find out the specific
* relationship.
*
- * @return the @if clike #QualifierType_t@... java qualifier type code@... value of this object or
- * @link QualifierType_t#UNKNOWN_QUALIFIER UNKNOWN_QUALIFIER@...
+ * @return the @if clike #QualifierType_t value@... qualifier type@...
+ * of this object or @link QualifierType_t#UNKNOWN_QUALIFIER UNKNOWN_QUALIFIER@...
* (the default).
*
* @see getResources()
@@ -375,7 +374,7 @@
/**
- * Returns the model qualifier type code for this CVTerm object.
+ * Returns the model qualifier type of this CVTerm object.
*
* @htmlinclude cvterm-common-description-text.html
*
@@ -399,15 +398,15 @@
* unknown by libSBML and reported as
* @link ModelQualifierType_t#BQM_UNKNOWN BQM_UNKNOWN@....
*
- * @return the @if clike #ModelQualifierType_t@... java model qualifier type code@... value of this object or
- * @link ModelQualifierType_t#BQM_UNKNOWN BQM_UNKNOWN@...
+ * @return the @if clike #ModelQualifierType_t value@... model qualifier type@...
+ * of this object or @link ModelQualifierType_t#BQM_UNKNOWN BQM_UNKNOWN@...
* (the default).
*/
ModelQualifierType_t getModelQualifierType();
/**
- * Returns the biological qualifier type code for this CVTerm object.
+ * Returns the biological qualifier type of this CVTerm object.
*
* @htmlinclude cvterm-common-description-text.html
*
@@ -440,8 +439,8 @@
* unknown by libSBML and reported as
* @link BiolQualifierType_t#BQB_UNKNOWN BQB_UNKNOWN@....
*
- * @return the @if clike #BiolQualifierType_t@... java biology qualifier type code@... value of this object or
- * @link BiolQualifierType_t#BQB_UNKNOWN BQB_UNKNOWN@...
+ * @return the @if clike #BiolQualifierType_t value@... biology qualifier type@...
+ * of this object or @link BiolQualifierType_t#BQB_UNKNOWN BQB_UNKNOWN@...
* (the default).
*/
BiolQualifierType_t getBiologicalQualifierType();
@@ -545,11 +544,11 @@
/**
- * Sets the @if clike #QualifierType_t@... java qualifier type code@... value of this CVTerm object.
+ * Sets the @if clike #QualifierType_t@... qualifier code@... of this
+ * CVTerm object.
*
- * @param type the @if clike #QualifierType_t@... java qualifier type code@... type value
- * function. The possible values
- * returned by this function are:
+ * @param type the @if clike #QualifierType_t value@... qualifier type@....
+ * The possible values returned by this function are:
* @li @link OperationReturnValues_t#LIBSBML_OPERATION_SUCCESS LIBSBML_OPERATION_SUCCESS@...
*
* @see getQualifierType()
@@ -558,13 +557,13 @@
/**
- * Sets the @if clike #ModelQualifierType_t@... java model qualifier type code@... value of this CVTerm object.
+ * Sets the @if clike #ModelQualifierType_t value@... model qualifier type@...
+ * of this CVTerm object.
*
- * @param type the @if clike #ModelQualifierType_t@... java model qualifier type code@... value
+ * @param type the @if clike #ModelQualifierType_t value@... model qualifier type@...
*
* @return integer value indicating success/failure of the
- * function. The possible values
- * returned by this function are:
+ * function. The possible values returned by this function are:
* @li @link OperationReturnValues_t#LIBSBML_OPERATION_SUCCESS LIBSBML_OPERATION_SUCCESS@...
* @li @link OperationReturnValues_t#LIBSBML_INVALID_ATTRIBUTE_VALUE LIBSBML_INVALID_ATTRIBUTE_VALUE@...
*
@@ -580,19 +579,19 @@
/**
- * Sets the @if clike #BiolQualifierType_t@... java biology qualifier type code@... of this CVTerm object.
+ * Sets the @if clike #BiolQualifierType_t value@... biology qualifier type@...
+ * of this CVTerm object.
*
- * @param type the @if clike #BiolQualifierType_t@... java biology qualifier type code@... value
+ * @param type the @if clike #BiolQualifierType_t value@... biology qualifier type@....
*
* @return integer value indicating success/failure of the
- * function. The possible values
- * returned by this function are:
+ * function. The possible values returned by this function are:
* @li @link OperationReturnValues_t#LIBSBML_OPERATION_SUCCESS LIBSBML_OPERATION_SUCCESS@...
* @li @link OperationReturnValues_t#LIBSBML_INVALID_ATTRIBUTE_VALUE LIBSBML_INVALID_ATTRIBUTE_VALUE@...
*
* @note If the Qualifier Type of this object is not
* @link QualifierType_t#BIOLOGICAL_QUALIFIER BIOLOGICAL_QUALIFIER@...,
- * then the @if clike #BiolQualifierType_t@... java biology qualifier type code@... value will default
+ * then the @if clike #BiolQualifierType_t value@... biology qualifier type@... will default
* to @link BiolQualifierType_t#BQB_UNKNOWN BQB_UNKNOWN@....
*
* @see getQualifierType()
@@ -620,18 +619,18 @@
* together identified uniquely using a URI. The following template
* illustrates the structure:
*
-<DIV class="fragment">
-<rdf:Description rdf:about="#<span style="border-bottom: 1px solid black">meta id</span>"><br>
- <span style="background-color: #ddd; border-bottom: 2px dotted #888">HISTORY</span><br>
- <<span style="background-color: #bbb">RELATION_ELEMENT</span>><br>
- <rdf:Bag><br>
- <rdf:li rdf:resource="<span style="background-color: #d0d0ee">resource URI</span>" /><br>
- <span style="background-color: #edd">...</span><br>
- </rdf:Bag><br>
- </<span style="background-color: #bbb">RELATION_ELEMENT</span>><br>
- <span style="background-color: #edd">...</span><br>
-</rdf:Description><br>
-</div>
+ <DIV class="fragment">
+ <rdf:Description rdf:about="#<span style="border-bottom: 1px solid black">meta id</span>"><br>
+ <span style="background-color: #e0e0e0; border-bottom: 2px dotted #888">HISTORY</span><br>
+ <<span style="background-color: #bbb">RELATION_ELEMENT</span>><br>
+ <rdf:Bag><br>
+ <rdf:li rdf:resource="<span style="background-color: #d0d0ee">resource URI</span>" /><br>
+ <span style="background-color: #edd">...</span><br>
+ </rdf:Bag><br>
+ </<span style="background-color: #bbb">RELATION_ELEMENT</span>><br>
+ <span style="background-color: #edd">...</span><br>
+ </rdf:Description><br>
+ </div>
*
* In the template above, the placeholder <span class="code"
* style="border-bottom: 1px solid black">meta id</span> stands for the
Modified: trunk/libsbml/src/annotation/RDFAnnotation.h
===================================================================
--- trunk/libsbml/src/annotation/RDFAnnotation.h 2011-02-27 05:14:17 UTC (rev 13062)
+++ trunk/libsbml/src/annotation/RDFAnnotation.h 2011-02-27 05:16:27 UTC (rev 13063)
@@ -44,7 +44,7 @@
* RDF-based annotations attached to a given SBML
* <code><annotation></code> element are read by RDFAnnotationParser
* and converted into a list of CVTerm objects. There
- * are different versions of the main method, @if clike RDFAnnotationParser::parseRDFAnnotation(const XMLNode *annotation, %List *CVTerms) @endif@... java RDFAnnotationParser::parseRDFAnnotation(const XMLNode *annotation, CVTermList *CVTerms) @endif
+ * are different versions of the main method, @if clike RDFAnnotationParser::parseRDFAnnotation(const XMLNode *annotation, %List *CVTerms) @else RDFAnnotationParser::parseRDFAnnotation(const XMLNode *annotation, CVTermList *CVTerms) @endif
* and RDFAnnotationParser::parseRDFAnnotation(const XMLNode *annotation),
* used depending on whether the annotation in question concerns the MIRIAM
* model history or other MIRIAM resource annotations. A special object
@@ -128,7 +128,7 @@
int success; // Status code variable, used below.
XMLNode *RDF = createRDFAnnotation(); // Create RDF annotation XML structure.
-success = RDF->addChild(content); // Put some content into it.
+success = RDF->addChild(...content...); // Put some content into it.
... // Check "success" return code value.
XMLNode *ann = createAnnotation(); // Create <annotation> container.
@@ -138,12 +138,12 @@
success = sbmlObject->setAnnotation(ann); // Set object's annotation to what we built.
... // Check "success" return code value.
@endverbatim
-@... java
+ * @endif@... java
@verbatim
int success; // Status code variable, used below.
XMLNode RDF = createRDFAnnotation(); // Create RDF annotation XML structure.
-success = RDF.addChild(content); // Put some content into it.
+success = RDF.addChild(...content...); // Put some content into it.
... // Check "success" return code value.
XMLNode ann = createAnnotation(); // Create <annotation> container.
@@ -153,7 +153,20 @@
success = sbmlObject.setAnnotation(ann); // Set object's annotation to what we built.
... // Check "success" return code value.
@endverbatim
-@...
+ * @endif@... python
+@verbatim
+RDF = RDFAnnotationParser.createRDFAnnotation() # Create RDF annotation XML structure.
+success = RDF.addChild(...content...) # Put some content into it.
+... # Check "success" return code value.
+
+annot = RDFAnnotationParser.createAnnotation() # Create <annotation> container.
+success = annot.addChild(RDF) # Put the RDF annotation into it.
+... # Check "success" return code value.
+
+success = sbmlObject.setAnnotation(annot) # Set object's annotation to what we built.
+... # Check "success" return code value.
+@endverbatim
+ * @endif
* The SBML specification contains more information about the format of
* annotations. We urge readers to consult Section 6 of the SBML
* Level 2 (Versions 2–4) and SBML Level 3 specification
@@ -185,7 +198,7 @@
*
* Note that this does not create the containing SBML
* <code><annotation></code> element; the method
- * @if clike createAnnotation()@endif@... java RDFAnnotationParser::createAnnotation()@endif
+ * @if clike createAnnotation()@else RDFAnnotationParser::createAnnotation()@endif
* is available for creating the container.
*
* @return a pointer to an XMLNode
@@ -233,7 +246,7 @@
* Note that this method does @em not create a complete annotation or
* even an RDF element; it only creates the "Description" portion. Callers
* will need to use other methods such as
- * @if clike createRDFAnnotation()@endif@... java RDFAnnotationParser::createRDFAnnotation()@endif
+ * @if clike createRDFAnnotation()@else RDFAnnotationParser::createRDFAnnotation()@endif
* to create the rest of the structure for an annotation.
*
* @param object the object to which the "Description" refers
@@ -252,7 +265,7 @@
*
* This essentially takes the given SBML object, reads out the CVTerm objects
* attached to it, calls
- * @if clike createRDFDescription()@endif@... java RDFAnnotationParser::createRDFDescription(SBase object)@endif
+ * @if clike createRDFDescription()@else RDFAnnotationParser::createRDFDescription(SBase object)@endif
* to create an RDF "Description" element to hold the terms and adds
* each term with appropriate qualifiers.
*
@@ -269,13 +282,13 @@
* around it.
*
* This essentially takes the given SBML object, calls
- * @if clike RDFAnnotationParser::createCVTerms()@endif@... java RDFAnnotationParser::createCVTerms(SBase object)@endif
+ * @if clike RDFAnnotationParser::createCVTerms()@else RDFAnnotationParser::createCVTerms(SBase object)@endif
* to read out the CVTerm objects
* attached to it, calls
- * @if clike createRDFAnnotation()@endif@... java RDFAnnotationParser::createRDFAnnotation()@endif
+ * @if clike createRDFAnnotation()@else RDFAnnotationParser::createRDFAnnotation()@endif
* to create an RDF
* annotation to hold the terms, and finally calls
- * @if clike createAnnotation()@endif@... java RDFAnnotationParser::createAnnotation()@endif
+ * @if clike createAnnotation()@else RDFAnnotationParser::createAnnotation()@endif
* to wrap the result as an SBML <code><annotation></code> element.
*
* @param object the SBML object to start from
Modified: trunk/libsbml/src/math/ASTNode.h
===================================================================
--- trunk/libsbml/src/math/ASTNode.h 2011-02-27 05:14:17 UTC (rev 13062)
+++ trunk/libsbml/src/math/ASTNode.h 2011-02-27 05:16:27 UTC (rev 13063)
@@ -80,7 +80,7 @@
*
*
* @if clike <h3><a class="anchor" name="ASTNodeType_t">
- * ASTNodeType_t</a></h3> @endif@... java <h3><a class="anchor"
+ * ASTNodeType_t</a></h3> @else <h3><a class="anchor"
* name="ASTNodeType_t">The set of possible %ASTNode types</a></h3> @endif
*
* @if clike Every ASTNode has an associated type code to indicate,
@@ -89,7 +89,7 @@
* @link ASTNode.h::ASTNodeType_t ASTNodeType_t@.... The list of
* possible types is quite long, because it covers all the mathematical
* functions that are permitted in SBML. The values are shown in the
- * following table: @endif@... java Every ASTNode has an associated
+ * following table: @else Every ASTNode has an associated
* type code to indicate, for example, whether it holds a number or stands for
* an arithmetic operator. The type is recorded as a value drawn from a
* set of static integer constants defined in the class {@link
@@ -142,8 +142,8 @@
*
* <h3><a class="anchor" name="math-convert">Converting between ASTs and text strings</a></h3>
*
- * The text-string form of mathematical formulas produced by @if clike SBML_formulaToString()@endif@... java <code><a href="libsbml.html#formulaToString(org.sbml.libsbml.ASTNode)">libsbml.formulaToString()</a></code>@endif and
- * read by @if clike SBML_parseFormula()@endif@... java <code><a href="libsbml.html#parseFormula(java.lang.String)">libsbml.parseFormula()</a></code>@endif
+ * The text-string form of mathematical formulas produced by @if clike SBML_formulaToString()@else <code><a href="libsbml.html#formulaToString(org.sbml.libsbml.ASTNode)">libsbml.formulaToString()</a></code>@endif and
+ * read by @if clike SBML_parseFormula()@else <code><a href="libsbml.html#parseFormula(java.lang.String)">libsbml.parseFormula()</a></code>@endif
* are simple C-inspired infix notation taken from SBML Level 1. A
* formula in this text-string form can be handed to a program that
* understands SBML Level 1 mathematical expressions, or used as part
@@ -386,10 +386,10 @@
* AST_UNKNOWN@.... If the type isn't supplied when caling this
* constructor, the caller should set the node type to something else as
* soon as possible using
- * @if clike setType()@endif@... java ASTNode::setType(int)@endif.
+ * @if clike setType()@else ASTNode::setType(int)@endif.
*
* @param type an optional
- * @if clike @link #ASTNodeType_t ASTNodeType_t@... java type@...
+ * @if clike @link #ASTNodeType_t ASTNodeType_t@... type@...
* code indicating the type of node to create.
*
* @if notcpp @docnote @htmlinclude warn-default-args-in-docs.html @endif
@@ -503,7 +503,7 @@
* render the representation invalid. Callers need to be careful to use
* this method in the context of other operations to create complete and
* correct formulas. The method
- * @if clike isWellFormedASTNode()@endif@... java ASTNode::isWellFormedASTNode()@endif
+ * @if clike isWellFormedASTNode()@else ASTNode::isWellFormedASTNode()@endif
* may also be useful for checking the results of node modifications.
*
* @see prependChild(ASTNode* child)
@@ -631,7 +631,7 @@
*
* @return the nth child of this ASTNode or @c NULL if this node has no nth
* child (<code>n > </code>
- * @if clike getNumChildren()@endif@... java ASTNode::getNumChildren()@endif
+ * @if clike getNumChildren()@else ASTNode::getNumChildren()@endif
* <code>- 1</code>).
*/
LIBSBML_EXTERN
@@ -642,7 +642,7 @@
* Get the left child of this node.
*
* @return the left child of this ASTNode. This is equivalent to calling
- * @if clike getChild()@endif@... java ASTNode::getChild(unsigned int)@endif
+ * @if clike getChild()@else ASTNode::getChild(unsigned int)@endif
* with an argument of @c 0.
*/
LIBSBML_EXTERN
@@ -654,7 +654,7 @@
*
* @return the right child of this ASTNode, or @c NULL if this node has no
* right child. If
- * @if clike getNumChildren()@endif@... java ASTNode::getNumChildren()@endif
+ * @if clike getNumChildren()@else ASTNode::getNumChildren()@endif
* <code>> 1</code>, then this is equivalent to:
* @code
* getChild( getNumChildren() - 1 );
@@ -721,7 +721,7 @@
*
* @return the nth annotation of this ASTNode, or @c NULL if this node has
* no nth annotation (<code>n ></code>
- * @if clike getNumChildren()@endif@... java ASTNode::getNumChildren()@endif
+ * @if clike getNumChildren()@else ASTNode::getNumChildren()@endif
* <code>- 1</code>).
*
* @see ASTNode::addSemanticsAnnotation(XMLNode* sAnnotation)
@@ -789,7 +789,7 @@
/**
* Get the value of this node as a single character. This function
* should be called only when
- * @if clike getType()@endif@... java ASTNode::getType()@endif returns
+ * @if clike getType()@else ASTNode::getType()@endif returns
* @link ASTNodeType_t#AST_PLUS AST_PLUS@...,
* @link ASTNodeType_t#AST_MINUS AST_MINUS@...,
* @link ASTNodeType_t#AST_TIMES AST_TIMES@...,
@@ -805,7 +805,7 @@
/**
* Get the value of this node as an integer. This function should be
* called only when
- * @if clike getType()@endif@... java ASTNode::getType()@endif
+ * @if clike getType()@else ASTNode::getType()@endif
* <code>== @link ASTNodeType_t#AST_INTEGER AST_INTEGER@...>.
*
* @return the value of this ASTNode as a (<code>long</code>) integer.
@@ -817,9 +817,9 @@
/**
* Get the value of this node as a string. This function may be called
* on nodes that (1) are not operators, i.e., nodes for which
- * @if clike isOperator()@endif@... java ASTNode::isOperator()@endif
+ * @if clike isOperator()@else ASTNode::isOperator()@endif
* returns @c false, and (2) are not numbers, i.e.,
- * @if clike isNumber()@endif@... java ASTNode::isNumber()@endif returns @c false.
+ * @if clike isNumber()@else ASTNode::isNumber()@endif returns @c false.
*
* @return the value of this ASTNode as a string.
*/
@@ -830,7 +830,7 @@
/**
* Get the value of the numerator of this node. This function should be
* called only when
- * @if clike getType()@endif@... java ASTNode::getType()@endif
+ * @if clike getType()@else ASTNode::getType()@endif
* <code>== @link ASTNodeType_t#AST_RATIONAL AST_RATIONAL@...>.
*
* @return the value of the numerator of this ASTNode.
@@ -842,7 +842,7 @@
/**
* Get the value of the denominator of this node. This function should
* be called only when
- * @if clike getType()@endif@... java ASTNode::getType()@endif
+ * @if clike getType()@else ASTNode::getType()@endif
* <code>== @link ASTNodeType_t#AST_RATIONAL AST_RATIONAL@...>.
*
* @return the value of the denominator of this ASTNode.
@@ -854,7 +854,7 @@
/**
* Get the real-numbered value of this node. This function
* should be called only when
- * @if clike isReal()@endif@... java ASTNode::isReal()@endif
+ * @if clike isReal()@else ASTNode::isReal()@endif
* <code>== true</code>.
*
* This function performs the necessary arithmetic if the node type is
@@ -870,13 +870,13 @@
/**
* Get the mantissa value of this node. This function should be called
- * only when @if clike getType()@endif@... java ASTNode::getType()@endif
+ * only when @if clike getType()@else ASTNode::getType()@endif
* returns @link ASTNodeType_t#AST_REAL_E AST_REAL_E@...
* or @link ASTNodeType_t#AST_REAL AST_REAL@....
- * If @if clike getType()@endif@... java ASTNode::getType()@endif
+ * If @if clike getType()@else ASTNode::getType()@endif
* returns @link ASTNodeType_t#AST_REAL AST_REAL@...,
* this method is identical to
- * @if clike getReal()@endif@... java ASTNode::getReal()@endif.
+ * @if clike getReal()@else ASTNode::getReal()@endif.
*
* @return the value of the mantissa of this ASTNode.
*/
@@ -887,7 +887,7 @@
/**
* Get the exponent value of this ASTNode. This function should be
* called only when
- * @if clike getType()@endif@... java ASTNode::getType()@endif
+ * @if clike getType()@else ASTNode::getType()@endif
* returns @link ASTNodeType_t#AST_REAL_E AST_REAL_E@...
* or @link ASTNodeType_t#AST_REAL AST_REAL@....
*
@@ -1158,7 +1158,7 @@
*
* For numbers, unary minus nodes can be "collapsed" by negating the
* number. In fact,
- * @if clike SBML_parseFormula()@endif@... java <code><a href="libsbml.html#parseFormula(java.lang.String)">libsbml.parseFormula()</a></code>@endif does this during its parsing process.
+ * @if clike SBML_parseFormula()@else <code><a href="libsbml.html#parseFormula(java.lang.String)">libsbml.parseFormula()</a></code>@endif does this during its parsing process.
* However, unary minus nodes for symbols
* (@link ASTNodeType_t#AST_NAME AST_NAME@...) cannot
* be "collapsed", so this predicate function is necessary.
@@ -1242,9 +1242,9 @@
* As a side-effect, this ASTNode object's type will be reset to
* @link ASTNodeType_t#AST_NAME AST_NAME@... if (and <em>only
* if</em>) the ASTNode was previously an operator (
- * @if clike isOperator()@endif@... java ASTNode::isOperator()@endif
+ * @if clike isOperator()@else ASTNode::isOperator()@endif
* <code>== true</code>), number (
- * @if clike isNumber()@endif@... java ASTNode::isNumber()@endif
+ * @if clike isNumber()@else ASTNode::isNumber()@endif
* <code>== true</code>), or unknown.
* This allows names to be set for @link ASTNodeType_t#AST_FUNCTION
* AST_FUNCTION@... nodes and the like.
@@ -1363,7 +1363,7 @@
* The units will be set @em only if this ASTNode object represents a
* MathML <code><cn></code> element, i.e., represents a number.
* Callers may use
- * @if clike isNumber()@endif@... java ASTNode::isNumber()@endif
+ * @if clike isNumber()@else ASTNode::isNumber()@endif
* to inquire whether the node is of that type.
*
* @htmlinclude about-sbml-units-attrib.html
Modified: trunk/libsbml/src/math/FormulaFormatter.h
===================================================================
--- trunk/libsbml/src/math/FormulaFormatter.h 2011-02-27 05:14:17 UTC (rev 13062)
+++ trunk/libsbml/src/math/FormulaFormatter.h 2011-02-27 05:16:27 UTC (rev 13063)
@@ -51,7 +51,7 @@
* this text-string form therefore can be handed to a program that
* understands SBML Level 1 mathematical expressions, or used as part
* of a formula translation system. The syntax is described in detail in
- * the documentation for ASTNode. @endif@... java The text-string form of
+ * the documentation for ASTNode. @else The text-string form of
* mathematical formulas produced by <code><a
* href="libsbml.html#formulaToString(org.sbml.libsbml.ASTNode)">
* libsbml.formulaToString()</a></code> and read by
Modified: trunk/libsbml/src/math/FormulaParser.h
===================================================================
--- trunk/libsbml/src/math/FormulaParser.h 2011-02-27 05:14:17 UTC (rev 13062)
+++ trunk/libsbml/src/math/FormulaParser.h 2011-02-27 05:16:27 UTC (rev 13063)
@@ -52,7 +52,7 @@
* this text-string form therefore can be handed to a program that
* understands SBML Level 1 mathematical expressions, or used as part
* of a formula translation system. The syntax is described in detail in
- * the documentation for ASTNode. @endif@... java The text-string form of
+ * the documentation for ASTNode. @else The text-string form of
* mathematical formulas produced by <code><a
* href="libsbml.html">libsbml.formulaToString()</a></code> and read by
* <code><a href="libsbml.html">libsbml.parseFormula()</a></code> are
Modified: trunk/libsbml/src/sbml/Compartment.h
===================================================================
--- trunk/libsbml/src/sbml/Compartment.h 2011-02-27 05:14:17 UTC (rev 13062)
+++ trunk/libsbml/src/sbml/Compartment.h 2011-02-27 05:16:27 UTC (rev 13063)
@@ -376,8 +376,7 @@
* (identifier) attribute of a Compartment is required to have a value.
* Thus, callers are cautioned to assign a value after calling this
* constructor. Setting the identifier can be accomplished using the
- * method
- * @if clike setId()@endif@... python setId()@endif@... java Compartment::setId(String id)@endif.
+ * method @if java Compartment::setId(String id)@else setId()@endif.
*
* @param sbmlns an SBMLNamespaces object.
*
@@ -522,14 +521,14 @@
* Get the size of this Compartment.
*
* This method is identical to
- * @if clike getVolume()@endif@... python getVolume()@endif@... java Compartment::getVolume()@endif.
+ * @if java Compartment::getVolume()@else getVolume()@endif.
* In SBML Level 1, compartments are always three-dimensional
* constructs and only have volumes, whereas in SBML Level 2,
* compartments may be other than three-dimensional and therefore the
* "volume" attribute is named "size" in Level 2. LibSBML provides
* both
- * @if clike getSize()@endif@... python getSize()@endif@... java Compartment::getSize()@endif and
- * @if clike getVolume()@endif@... python getVolume()@endif@... java Compartment::getVolume()@endif for
+ * @if java Compartment::getSize()@else getSize()@endif and
+ * @if java Compartment::getVolume()@else getVolume()@endif for
* easier compatibility between SBML Levels.
*
* @return the value of the "size" attribute ("volume" in Level 1) of
@@ -545,14 +544,14 @@
* Get the volume of this Compartment.
*
* This method is identical to
- * @if clike getSize()@endif@... python getSize()@endif@... java Compartment::getSize()@endif. In
+ * @if java Compartment::getSize()@else getSize()@endif. In
* SBML Level 1, compartments are always three-dimensional
* constructs and only have volumes, whereas in SBML Level 2,
* compartments may be other than three-dimensional and therefore the
* "volume" attribute is named "size" in Level 2. LibSBML provides
* both
- * @if clike getSize()@endif@... python getSize()@endif@... java Compartment::getSize()@endif and
- * @if clike getVolume()@endif@... python getVolume()@endif@... java Compartment::getVolume()@endif
+ * @if java Compartment::getSize()@else getSize()@endif and
+ * @if java Compartment::getVolume()@else getVolume()@endif
* for easier compatibility between SBML Levels.
*
* @return the value of the "volume" attribute ("size" in Level 2) of
@@ -581,7 +580,7 @@
* @note @htmlinclude unassigned-units-are-not-a-default.html
*
* @see isSetUnits()
- * @see @if clike setUnits()@endif@... python setUnits()@endif@... java Compartment::setUnits(String sid)@endif
+ * @see @if java Compartment::setUnits(String sid)@else setUnits()@endif
* @see getSize()
*/
const std::string& getUnits () const;
@@ -647,14 +646,12 @@
* Compartment's "size" attribute is set.
*
* This method is similar but not identical to
- * @if clike isSetVolume()@endif@... python isSetVolume()@endif@... java Compartment::isSetVolume()@endif. The latter
+ * @if java Compartment::isSetVolume()@else isSetVolume()@endif. The latter
* should be used in the context of SBML Level 1 models instead of
- * @if clike isSetSize()@endif@... python isSetSize()@endif@... java Compartment::isSetSize()@endif
- * because
- * @if clike isSetVolume()@endif@... python isSetVolume()@endif@... java Compartment::isSetVolume()@endif
- * performs extra processing to take
- * into account the difference in default values between SBML Levels 1
- * and 2.
+ * @if java Compartment::isSetSize()@else isSetSize()@endif
+ * because @if java Compartment::isSetVolume()@else isSetVolume()@endif
+ * performs extra processing to take into account the difference in
+ * default values between SBML Levels 1 and 2.
*
* @return @c true if the "size" attribute ("volume" in Level 2) of
* this Compartment is set, @c false otherwise.
@@ -670,7 +667,7 @@
* "volume" attribute is set.
*
* This method is similar but not identical to
- * @if clike isSetSize()@endif@... python isSetSize()@endif@... java Compartment::isSetSize()@endif. The latter
+ * @if java Compartment::isSetSize()@else isSetSize()@endif. The latter
* should not be used in the context of SBML Level 1 models because this
* method performs extra processing to take into account
* the difference in default values between SBML Levels 1 and 2.
@@ -687,7 +684,7 @@
* therefore may or may not be set.
*
* @see isSetSize()
- * @see @if clike setVolume()@endif@... python setVolume()@endif@... java Compartment::setVolume(double value)@endif
+ * @see @if java Compartment::setVolume(double value)@else setVolume()@endif
*/
bool isSetVolume () const;
@@ -831,7 +828,7 @@
* Compartment.
*
* This method is identical to
- * @if clike setVolume()@endif@... python setVolume()@endif@... java Compartment::setVolume(double value)@endif
+ * @if java Compartment::setVolume(double value)@else setVolume()@endif
* and is provided for compatibility between
* SBML Level 1 and Level 2.
*
@@ -855,7 +852,7 @@
* Compartment.
*
* This method is identical to
- * @if clike setVolume()@endif@... python setVolume()@endif@... java Compartment::setVolume(double value)@endif
+ * @if java Compartment::setVolume(double value)@else setVolume()@endif
* and is provided for compatibility between SBML Level 1 and
* Level 2.
*
@@ -1050,7 +1047,7 @@
*
* Note that unit declarations for Compartment objects are specified in
* terms of the @em identifier of a unit (e.g., using
- * @if clike setUnits()@endif@... python setUnits()@endif@... java Compartment::setUnits(String sid)@endif), but
+ * @if java Compartment::setUnits(String sid)@else setUnits()@endif), but
* @em this method returns a UnitDefinition object, not a unit
* identifier. It does this by constructing an appropriate
* UnitDefinition. For SBML Level 2 models, it will do this even
Modified: trunk/libsbml/src/sbml/CompartmentType.h
===================================================================
--- trunk/libsbml/src/sbml/CompartmentType.h 2011-02-27 05:14:17 UTC (rev 13062)
+++ trunk/libsbml/src/sbml/CompartmentType.h 2011-02-27 05:16:27 UTC (rev 13063)
@@ -172,7 +172,7 @@
* (identifier) attribute of a CompartmentType is required to have a value.
* Thus, callers are cautioned to assign a value after calling this
* constructor. Setting the identifier can be accomplished using the
- * method @if clike setId() @endif@... python setId() @endif@... java setId(String id) @endif.
+ * method setId(@if java String id@...).
*
* @param sbmlns an SBMLNamespaces object.
*
Modified: trunk/libsbml/src/sbml/InitialAssignment.h
===================================================================
--- trunk/libsbml/src/sbml/InitialAssignment.h 2011-02-27 05:14:17 UTC (rev 13062)
+++ trunk/libsbml/src/sbml/InitialAssignment.h 2011-02-27 05:16:27 UTC (rev 13063)
@@ -400,7 +400,7 @@
* The units are calculated based on the mathematical expression in the
* InitialAssignment and the model quantities referenced by
* <code><ci></code> elements used within that expression. The
- * @if clike getDerivedUnitDefinition()@endif@... python getDerivedUnitDefinition()@endif@... java InitialAssignment::getDerivedUnitDefinition()@endif
+ * @if java InitialAssignment::getDerivedUnitDefinition()@else getDerivedUnitDefinition()@endif
* method returns the calculated units.
*
* Note that the functionality that facilitates unit analysis depends
@@ -413,13 +413,13 @@
* units. In those cases, it is not possible to calculate the units of
* the overall expression without making assumptions. LibSBML does not
* make assumptions about the units, and
- * @if clike getDerivedUnitDefinition()@endif@... python getDerivedUnitDefinition()@endif@... java InitialAssignment::getDerivedUnitDefinition()@endif
+ * @if java InitialAssignment::getDerivedUnitDefinition()@else getDerivedUnitDefinition()@endif
* only returns the units as far as it is able to determine them. For
* example, in an expression <em>X + Y</em>, if <em>X</em> has
* unambiguously-defined units and <em>Y</em> does not, it will return
* the units of <em>X</em>. <strong>It is important that callers also
* invoke the method</strong>
- * @if clike containsUndeclaredUnits()@endif@... python containsUndeclaredUnits()@endif@... java InitialAssignment::containsUndeclaredUnits()@endif
+ * @if java InitialAssignment::containsUndeclaredUnits()@else containsUndeclaredUnits()@endif
* <strong>to determine whether this situation holds</strong>. Callers
* may wish to take suitable actions in those scenarios.
*
@@ -439,7 +439,7 @@
* The units are calculated based on the mathematical expression in the
* InitialAssignment and the model quantities referenced by
* <code><ci></code> elements used within that expression. The
- * @if clike getDerivedUnitDefinition()@endif@... python getDerivedUnitDefinition()@endif@... java InitialAssignment::getDerivedUnitDefinition()@endif
+ * @if java InitialAssignment::getDerivedUnitDefinition()@else getDerivedUnitDefinition()@endif
* method returns the calculated units.
*
* Note that the functionality that facilitates unit analysis depends
@@ -452,13 +452,13 @@
* units. In those cases, it is not possible to calculate the units of
* the overall expression without making assumptions. LibSBML does not
* make assumptions about the units, and
- * @if clike getDerivedUnitDefinition()@endif@... python getDerivedUnitDefinition()@endif@... java InitialAssignment::getDerivedUnitDefinition()@endif
+ * @if java InitialAssignment::getDerivedUnitDefinition()@else getDerivedUnitDefinition()@endif
* only returns the units as far as it is able to determine them. For
* example, in an expression <em>X + Y</em>, if <em>X</em> has
* unambiguously-defined units and <em>Y</em> does not, it will return
* the units of <em>X</em>. <strong>It is important that callers also
* invoke the method</strong>
- * @if clike containsUndeclaredUnits()@endif@... python containsUndeclaredUnits()@endif@... java InitialAssignment::containsUndeclaredUnits()@endif
+ * @if java InitialAssignment::containsUndeclaredUnits()@else containsUndeclaredUnits()@endif
* <strong>to determine whether this situation holds</strong>. Callers
* may wish to take suitable actions in those scenarios.
*
@@ -481,7 +481,7 @@
*
* @note A return value of @c true indicates that the UnitDefinition
* returned by
- * @if clike getDerivedUnitDefinition()@endif@... python getDerivedUnitDefinition()@endif@... java InitialAssignment::getDerivedUnitDefinition()@endif
+ * @if java InitialAssignment::getDerivedUnitDefinition()@else getDerivedUnitDefinition()@endif
* may not accurately represent the units of the expression.
*
* @see getDerivedUnitDefinition()
@@ -500,7 +500,7 @@
*
* @note A return value of @c true indicates that the UnitDefinition
* returned by
- * @if clike getDerivedUnitDefinition()@endif@... python getDerivedUnitDefinition()@endif@... java InitialAssignment::getDerivedUnitDefinition()@endif
+ * @if java InitialAssignment::getDerivedUnitDefinition()@else getDerivedUnitDefinition()@endif
* may not accurately represent the units of the expression.
*
* @see getDerivedUnitDefinition()
Modified: trunk/libsbml/src/sbml/KineticLaw.h
===================================================================
--- trunk/libsbml/src/sbml/KineticLaw.h 2011-02-27 05:14:17 UTC (rev 13062)
+++ trunk/libsbml/src/sbml/KineticLaw.h 2011-02-27 05:16:27 UTC (rev 13063)
@@ -226,7 +226,7 @@
* it as as a text string.
*
* This is fundamentally equivalent to
- * @if clike getMath()@endif@... python getMath()@endif@... java KineticLaw::getMath()@endif.
+ * @if java KineticLaw::getMath()@else getMath()@endif.
* This variant is provided principally for compatibility compatibility
* with SBML Level 1.
*
@@ -244,7 +244,7 @@
* it as as an AST.
*
* This is fundamentally equivalent to
- * @if clike getFormula()@endif@... python getFormula()@endif@... java KineticLaw::getFormula()@endif.
+ * @if java KineticLaw::getFormula()@else getFormula()@endif.
* The latter is provided principally for compatibility compatibility
* with SBML Level 1, which represented mathematical formulas in
* text-string form.
@@ -291,10 +291,10 @@
* KineticLaw's "formula" attribute is set.
*
* This is functionally identical to the method
- * @if clike isSetMath()@endif@... python isSetMath()@endif@... java KineticLaw::isSetMath()@endif. It is
+ * @if java KineticLaw::isSetMath()@else isSetMath()@endif. It is
* provided in order to mirror the parallel between
- * @if clike getFormula()@endif@... python getFormula()@endif@... java KineticLaw::getFormula()@endif and
- * @if clike getMath()@endif@... python getMath()@endif@... java KineticLaw::getMath()@endif.
+ * @if java KineticLaw::getFormula()@else getFormula()@endif and
+ * @if java KineticLaw::getMath()@else getMath()@endif.
*
* @return @c true if the formula (meaning the @c math subelement) of
* this KineticLaw is set, @c false otherwise.
@@ -311,10 +311,10 @@
* Kinetic's "math" subelement is set.
*
* This is identical to the method
- * @if clike isSetFormula()@endif@... python isSetFormula()@endif@... java KineticLaw::isSetFormula()@endif.
+ * @if java KineticLaw::isSetFormula()@else isSetFormula()@endif.
* It is provided in order to mirror the parallel between
- * @if clike getFormula()@endif@... python getFormula()@endif@... java KineticLaw::getFormula()@endif and
- * @if clike getMath()@endif@... python getMath()@endif@... java KineticLaw::getMath()@endif.
+ * @if java KineticLaw::getFormula()@else getFormula()@endif and
+ * @if java KineticLaw::getMath()@else getMath()@endif.
*
* @return @c true if the formula (meaning the @c math subelement) of
* this KineticLaw is set, @c false otherwise.
@@ -384,7 +384,7 @@
* of the given ASTNode.
*
* This is fundamentally identical to
- * @if clike getFormula()@endif@... python getFormula()@endif@... java KineticLaw::setFormula(String formula)@endif.
+ * @if java KineticLaw::setFormula(String formula)@else getFormula()@endif.
* The latter is provided principally for compatibility compatibility with
* SBML Level 1, which represented mathematical formulas in text-string
* form.
@@ -511,7 +511,7 @@
* instance in the KineticLaw</em>. In addition, the caller should make
* sure to free the original object if it is no longer being used, or
* else a memory leak will result. Please see
- * @if clike createParameter()@endif@... python createParameter()@endif@... java KineticLaw::createParameter()@endif
+ * @if java KineticLaw::createParameter()@else createParameter()@endif
* for a method that does not lead to these issues.
*
* @see createParameter()
@@ -543,7 +543,7 @@
* instance in the KineticLaw</em>. In addition, the caller should make
* sure to free the original object if it is no longer being used, or
* else a memory leak will result. Please see
- * @if clike createParameter()@endif@... python createParameter()@endif@... java KineticLaw::createParameter()@endif
+ * @if java KineticLaw::createParameter()@else createParameter()@endif
* for a method that does not lead to these issues.
*
* @see createLocalParameter()
@@ -717,7 +717,7 @@
* The units are calculated based on the mathematical expression in the
* KineticLaw and the model quantities referenced by
* <code><ci></code> elements used within that expression. The
- * @if clike getDerivedUnitDefinition()@endif@... python getDerivedUnitDefinition()@endif@... java KineticLaw::getDerivedUnitDefinition()@endif
+ * @if java KineticLaw::getDerivedUnitDefinition()@else getDerivedUnitDefinition()@endif
* method returns the calculated units.
*
* Note that the functionality that facilitates unit analysis depends
@@ -730,13 +730,13 @@
* units. In those cases, it is not possible to calculate the units of
* the overall expression without making assumptions. LibSBML does not
* make assumptions about the units, and
- * @if clike getDerivedUnitDefinition()@endif@... python getDerivedUnitDefinition()@endif@... java KineticLaw::getDerivedUnitDefinition()@endif
+ * @if java KineticLaw::getDerivedUnitDefinition()@else getDerivedUnitDefinition()@endif
* only returns the units as far as it is able to determine them. For
* example, in an expression <em>X + Y</em>, if <em>X</em> has
* unambiguously-defined units and <em>Y</em> does not, it will return
* the units of <em>X</em>. <strong>It is important that callers also
* invoke the method</strong>
- * @if clike containsUndeclaredUnits()@endif@... java KineticLaw::containsUndeclaredUnits()@endif
+ * @if java KineticLaw::containsUndeclaredUnits()@else containsUndeclaredUnits()@endif
* <strong>to determine whether this situation holds</strong>. Callers may
* wish to take suitable actions in those scenarios.
*
@@ -756,7 +756,7 @@
* The units are calculated based on the mathematical expression in the
* KineticLaw and the model quantities referenced by
* <code><ci></code> elements used within that expression. The
- * @if clike getDerivedUnitDefinition()@endif@... python getDerivedUnitDefinition()@endif@... java KineticLaw::getDerivedUnitDefinition()@endif
+ * @if java KineticLaw::getDerivedUnitDefinition()@else getDerivedUnitDefinition()@endif
* method returns the calculated units.
*
* Note that the functionality that facilitates unit analysis depends
@@ -769,13 +769,13 @@
* units. In those cases, it is not possible to calculate the units of
* the overall expression without making assumptions. LibSBML does not
* make assumptions about the units, and
- * @if clike getDerivedUnitDefinition()@endif@... python getDerivedUnitDefinition()@endif@... java KineticLaw::getDerivedUnitDefinition()@endif
+ * @if java KineticLaw::getDerivedUnitDefinition()@else getDerivedUnitDefinition()@endif
* only returns the units as far as it is able to determine them. For
* example, in an expression <em>X + Y</em>, if <em>X</em> has
* unambiguously-defined units and <em>Y</em> does not, it will return
* the units of <em>X</em>. <strong>It is important that callers also
* invoke the method</strong>
- * @if clike containsUndeclaredUnits()@endif@... java KineticLaw::containsUndeclaredUnits()@endif
+ * @if java KineticLaw::containsUndeclaredUnits()@else containsUndeclaredUnits()@endif
* <strong>to determine whether this situation holds</strong>. Callers
* may wish to take suitable actions in those scenarios.
*
@@ -798,7 +798,7 @@
*
* @note A return value of @c true indicates that the UnitDefinition
* returned by
- * @if clike getDerivedUnitDefinition()@endif@... python getDerivedUnitDefinition()@endif@... java KineticLaw::getDerivedUnitDefinition()@endif
+ * @if java KineticLaw::getDerivedUnitDefinition()@else getDerivedUnitDefinition()@endif
* may not accurately represent the units of the expression.
*
* @see getDerivedUnitDefinition()
@@ -817,7 +817,7 @@
*
* @note A return value of @c true indicates that the UnitDefinition
* returned by
- * @if clike getDerivedUnitDefinition()@endif@... python getDerivedUnitDefinition()@endif@... java KineticLaw::getDerivedUnitDefinition()@endif
+ * @if java KineticLaw::getDerivedUnitDefinition()@else getDerivedUnitDefinition()@endif
* may not accurately represent the units of the expression.
*
* @see getDerivedUnitDefinition()
Modified: trunk/libsbml/src/sbml/LocalParameter.h
===================================================================
--- trunk/libsbml/src/sbml/LocalParameter.h 2011-02-27 05:14:17 UTC (rev 13062)
+++ trunk/libsbml/src/sbml/LocalParameter.h 2011-02-27 05:16:27 UTC (rev 13063)
@@ -201,7 +201,7 @@
* Thus, callers are cautioned to assign a value after calling this
* constructor if no identifier is provided as an argument. Setting the
* identifier can be accomplished using the method
- * @if clike setId()@endif@... python setId()@endif@... java setId(String id)@endif.
+ * @if java setId(String id)@else setId()@endif.
*
* @param sbmlns an SBMLNamespaces object.
*
Modified: trunk/libsbml/src/sbml/Model.h
===================================================================
--- trunk/libsbml/src/sbml/Model.h 2011-02-27 05:14:17 UTC (rev 13062)
+++ trunk/libsbml/src/sbml/Model.h 2011-02-27 05:16:27 UTC (rev 13063)
@@ -94,7 +94,8 @@
* @section approaches Approaches to creating objects using the libSBML API
*
* LibSBML provides two main mechanisms for creating objects: class
- * constructors (e.g., @if clike @link Species::Species() Species() @endlink @endif@... python @link Species::Species() Species() @endlink @endif@... java <a href="org/sbml/libsbml/Species.html">Species()</a> @endif),
+ * constructors
+ * (e.g., @if java <a href="org/sbml/libsbml/Species.html">Species()</a> @else Species::Species() @endif),
* and <code>create<span class="placeholder"><em>Object</em></span>()</code>
* methods (such as Model::createSpecies()) provided by certain <span
* class="placeholder"><em>Object</em></span> classes such as Model. These
@@ -127,7 +128,7 @@
Species *sp = model->createSpecies();
sp->setId("MySpecies");
@endverbatim
-@... java
+ * @endif@... java
@verbatim
// Create an SBMLDocument object in Level 3 Version 1 format:
@@ -149,7 +150,7 @@
Species sp = model.createSpecies();
sp.setId("BestSpeciesEver");
@endverbatim
-@...
+ * @endif
*
* The <code>create<span
* class="placeholder"><em>Object</em></span>()</code> methods return a
@@ -183,7 +184,7 @@
delete newsp;
@endverbatim
-@... java
+ * @endif@... java
@verbatim
// Create a Species object and add it to the model.
// This uses the Species class constructor:
@@ -197,14 +198,14 @@
newsp.setId("NewId"); // Warning -- doesn't change the species in 'model'!
@endverbatim
-@...
+ * @endif
*
- * The key point of the example above is that, because the @if clike Model::addSpecies() @endif@... python Model::addSpecies() @endif@... java Model::addSpecies(Species s) @endif
+ * The key point of the example above is that, because the
+ * @if java Model::addSpecies(Species s)@else Model::addSpecies()@endif
* call makes a copy of the object handed to it, care is needed
- * @if clike both when
- * attempting to make changes to the object, and when the original object
- * is no longer needed.@... java when
- * attempting to make changes to the object.@...
+ * @if clike both when attempting to make changes to the object, and when
+ * the original object is no longer needed.@... when attempting to make
+ * changes to the object.@...
*
* @section checking Consistency and adherence to SBML specifications
*
Modified: trunk/libsbml/src/sbml/Parameter.h
===================================================================
--- trunk/libsbml/src/sbml/Parameter.h 2011-02-27 05:14:17 UTC (rev 13062)
+++ trunk/libsbml/src/sbml/Parameter.h 2011-02-27 05:16:27 UTC (rev 13063)
@@ -229,7 +229,7 @@
* Thus, callers are cautioned to assign a value after calling this
* constructor if no identifier is provided as an argument. Setting the
* identifier can be accomplished using the method
- * @if clike setId()@endif@... python setId()@endif@... java setId(String id)@endif.
+ * @if java setId(String id)@else setId()@endif.
*
* @param sbmlns an SBMLNamespaces object.
*
Modified: trunk/libsbml/src/sbml/Rule.h
===================================================================
--- trunk/libsbml/src/sbml/Rule.h 2011-02-27 05:14:17 UTC (rev 13062)
+++ trunk/libsbml/src/sbml/Rule.h 2011-02-27 05:16:27 UTC (rev 13063)
@@ -174,7 +174,7 @@
* Level 3 for distinguishing rules; specifically, it uses an
* attribute whose value is drawn from an enumeration of 3 values. LibSBML
* supports this using methods that work @if clike a libSBML enumeration
- * type, #RuleType_t, whose values are @endif@... notcpp with the enumeration
+ * type, #RuleType_t, whose values are @else with the enumeration
* values @endif listed in the following table.
*
* <p>
@@ -367,7 +367,7 @@
* Level 3 for distinguishing rules; specifically, it uses an
* attribute whose value is drawn from an enumeration of 3 values. LibSBML
* supports this using methods that work @if clike a libSBML enumeration
- * type, #RuleType_t, whose values are @endif@... notcpp with the enumeration
+ * type, #RuleType_t, whose values are @else with the enumeration
* values @endif listed in the following table.
*
* <p>
@@ -604,7 +604,7 @@
* Level 3 for distinguishing rules; specifically, it uses an
* attribute whose value is drawn from an enumeration of 3 values. LibSBML
* supports this using methods that work @if clike a libSBML enumeration
- * type, #RuleType_t, whose values are @endif@... notcpp with the enumeration
+ * type, #RuleType_t, whose values are @else with the enumeration
* values @endif listed in the following table.
*
* <p>
@@ -818,7 +818,7 @@
* Level 3 for distinguishing rules; specifically, it uses an
* attribute whose value is drawn from an enumeration of 3 values. LibSBML
* supports this using methods that work @if clike a libSBML enumeration
- * type, #RuleType_t, whose values are @endif@... notcpp with the enumeration
+ * type, #RuleType_t, whose values are @else with the enumeration
* values @endif listed in the following table.
*
* <p>
@@ -962,7 +962,7 @@
* Returns the mathematical expression of this Rule in text-string form.
*
* The text string is produced by
- * @if clike SBML_formulaToString()@endif@... python SBML_formulaToString()@endif@... java <code><a href="libsbml.html#formulaToString(org.sbml.libsbml.ASTNode)">libsbml.formulaToString()</a></code>@endif; please consult
+ * @if java <code><a href="libsbml.html#formulaToString(org.sbml.libsbml.ASTNode)">libsbml.formulaToString()</a></code>@else SBML_formulaToString()@endif; please consult
* the documentation for that function to find out more about the format
* of the text-string formula.
*
@@ -1244,7 +1244,7 @@
* unambiguously-defined units and <em>Y</em> does not, it will return
* the units of <em>X</em>. <strong>It is important that callers also
* invoke the method</strong>
- * @if clike containsUndeclaredUnits()@endif@... python containsUndeclaredUnits()@endif@... java Rule::containsUndeclaredUnits()@endif
+ * @if java Rule::containsUndeclaredUnits()@else containsUndeclaredUnits()@endif
* <strong>to determine whether this situation holds</strong>. Callers may
* wish to take suitable actions in those scenarios.
*
@@ -1280,7 +1280,7 @@
* unambiguously-defined units and <em>Y</em> does not, it will return
* the units of <em>X</em>. <strong>It is important that callers also
* invoke the method</strong>
- * @if clike containsUndeclaredUnits()@endif@... python containsUndeclaredUnits()@endif@... java Rule::containsUndeclaredUnits()@endif
+ * @if java Rule::containsUndeclaredUnits()@else containsUndeclaredUnits()@endif
* <strong>to determine whether this situation holds</strong>. Callers
* may wish to take suitable actions in those scenarios.
*
@@ -1644,7 +1644,7 @@
* AlgebraicRule
*
* @note Upon the addition of an AlgebraicRule object to an SBMLDocument
- * (e.g., using @if clike Model::addRule()@endif@... python Model::addRule()@endif@... java Model::addRule(Rule r)@endif), the SBML Level, SBML Version
+ * (e.g., using @if java Model::addRule(Rule r)@else Model::addRule()@endif), the SBML Level, SBML Version
* and XML namespace of the document @em override the values used
* when creating the AlgebraicRule object via this constructor. This is
* necessary to ensure that an SBML document is a consistent structure.
@@ -1671,7 +1671,7 @@
* @param sbmlns an SBMLNamespaces object.
*
* @note Upon the addition of a AlgebraicRule object to an SBMLDocument
- * (e.g., using @if clike Model::addRule()@endif@... python Model::addRule()@endif@... java Model::addRule(Rule r)@endif, the SBML XML namespace of the
+ * (e.g., using @if java Model::addRule(Rule r)@else Model::addRule()@endif, the SBML XML namespace of the
* document @em overrides the value used when creating the AlgebraicRule
* object via this constructor. This is necessary to ensure that an SBML
* document is a consistent structure. Nevertheless, the ability to
@@ -1786,7 +1786,7 @@
* AssignmentRule
*
* @note Upon the addition of an AssignmentRule object to an SBMLDocument
- * (e.g., using @if clike Model::addRule()@endif@... python Model::addRule()@endif@... java Model::addRule(Rule r)@endif, the SBML Level, SBML Version
+ * (e.g., using @if java Model::addRule(Rule r)@else Model::addRule()@endif, the SBML Level, SBML Version
* and XML namespace of the document @em override the values used
* when creating the AssignmentRule object via this constructor. This is
* necessary to ensure that an SBML document is a consistent structure.
@@ -1813,7 +1813,7 @@
* @param sbmlns an SBMLNamespaces object.
*
* @note Upon the addition of a AssignmentRule object to an SBMLDocument
- * (e.g., using @if clike Model::addRule()@endif@... python Model::addRule()@endif@... java Model::addRule(Rule r)@endif, the SBML XML namespace of
+ * (e.g., using @if java Model::addRule(Rule r)@else Model::addRule()@endif, the SBML XML namespace of
* the document @em overrides the value used when creating the
* AssignmentRule object via this constructor. This is necessary to
* ensure that an SBML document is a consistent structure. Nevertheless,
@@ -1918,7 +1918,7 @@
* RateRule
*
* @note Upon the addition of a RateRule object to an SBMLDocument
- * (e.g., using @if clike Model::addRule()@endif@... python Model::addRule()@endif@... java Model::addRule(Rule r)@endif, the SBML Level, SBML Version
+ * (e.g., using @if java Model::addRule(Rule r)@else Model::addRule()@endif, the SBML Level, SBML Version
* and XML namespace of the document @em override the values used
* when creating the RateRule object via this constructor. This is
* necessary to ensure that an SBML document is a consistent structure.
@@ -1945,7 +1945,7 @@
* @param sbmlns an SBMLNamespaces object.
*
* @note Upon the addition of a RateRule object to an SBMLDocument (e.g.,
- * using @if clike Model::addRule()@endif@... python Model::addRule()@endif@... java Model::addRule(Rule r)@endif, the SBML XML namespace of the document
+ * using @if java Model::addRule(Rule r)@else Model::addRule()@endif, the SBML XML namespace of the document
* @em overrides the value used when creating the RateRule object via
* this constructor. This is necessary to ensure that an SBML document
* is a consistent structure. Nevertheless, the ability to supply the
Modified: trunk/libsbml/src/sbml/SBMLDocument.h
===================================================================
--- trunk/libsbml/src/sbml/SBMLDocument.h 2011-02-27 05:14:17 UTC (rev 13062)
+++ trunk/libsbml/src/sbml/SBMLDocument.h 2011-02-27 05:16:27 UTC (rev 13063)
@@ -80,8 +80,7 @@
* @verbatim
<sbml xmlns="http://www.sbml.org/sbml/level2/version4" level="2" version="4">
...
-</sbml>
-@...
+</sbml>@endverbatim
*
* SBMLDocument is derived from SBase, and therefore contains the usual SBase
* attributes (in SBML Level 2 and Level 3) of "metaid" and "sboTerm", as
@@ -161,7 +160,7 @@
* calling SBMLDocument::getNumErrors()</li>
*
* <li style="margin-bottom: 0.5em">
- * Call @if clike SBMLDocument::setConsistencyChecks() @endif@... python SBMLDocument::setConsistencyChecks() @endif@... java SBMLDocument::setConsistencyChecks(int categ, boolean onoff) @endif to configure which checks
+ * Call @if java SBMLDocument::setConsistencyChecks(int categ, boolean onoff) @else SBMLDocument::setConsistencyChecks() @endif to configure which checks
* will be performed by SBMLDocument::checkConsistency()</li>
*
* <li>Call SBMLDocument::checkConsistency(), then inquire about the results by
@@ -176,7 +175,7 @@
* to inquire about the results by using SBMLDocument::getNumErrors()</li>
*
* <li style="margin-bottom: 0.5em">
- * Call @if clike SBMLDocument::setConsistencyChecks() @endif@... python SBMLDocument::setConsistencyChecks() @endif@... java SBMLDocument::setConsistencyChecks(int categ, boolean onoff) @endif to configure which
+ * Call @if java SBMLDocument::setConsistencyChecks(int categ, boolean onoff) @else SBMLDocument::setConsistencyChecks() @endif to configure which
* checks are performed by SBMLDocument::checkConsistency()</li>
*
* <li>Call SBMLDocument::checkConsistency(), then inquire about the results
@@ -194,18 +193,18 @@
*
* LibSBML provides facilities for limited translation of SBML between
* Levels and Versions of the SBML specifications. The method for doing is
- * is @if clike setLevelAndVersion() @endif@... python setLevelAndVersion() @endif@... java SBMLDocument::setLevelAndVersion(long lev, long ver, boolean strict) @endif. In
+ * is @if java SBMLDocument::setLevelAndVersion(long lev, long ver, boolean strict) @else setLevelAndVersion() @endif. In
* general, models can be converted upward without difficulty (e.g., from
* SBML Level 1 to Level 2, or from an earlier Version of
* Level 2 to the latest Version of Level 2). Sometimes models
* can be translated downward as well, if they do not use constructs
* specific to more advanced Levels of SBML.
*
- * Calling @if clike SBMLDocument::setLevelAndVersion() @endif@... python SBMLDocument::setLevelAndVersion() @endif@... java SBMLDocument::setLevelAndVersion(long lev, long ver, boolean strict) @endif will not @em necessarily lead
+ * Calling @if java SBMLDocument::setLevelAndVersion(long lev, long ver, boolean strict) @else SBMLDocument::setLevelAndVersion() @endif will not @em necessarily lead
* to a successful conversion. The method will return a boolean value
* to indicate success or failure. Callers must check the error log (see
* next section) attached to the SBMLDocument object after calling
- * @if clike SBMLDocument::setLevelAndVersion() @endif@... python SBMLDocument::setLevelAndVersion() @endif@... java SBMLDocument::setLevelAndVersion(long lev, long ver) @endif in order to assess whether any
+ * @if java SBMLDocument::setLevelAndVersion(long lev, long ver) @else SBMLDocument::setLevelAndVersion() @endif in order to assess whether any
* problems arose.
*
* If an application is interested in translating to a lower Level and/or
@@ -239,7 +238,7 @@
* reported through a single common interface involving the object class
* SBMLError.
*
- * The methods SBMLDocument::getNumErrors(), @if clike SBMLDocument::getError() @endif@... python SBMLDocument::getError() @endif@... java SBMLDocument::getError(long n) @endif and
+ * The methods SBMLDocument::getNumErrors(), @if java SBMLDocument::getError(long n) @else SBMLDocument::getError() @endif and
* SBMLDocument::printErrors() allow callers to interact with the warnings
* or errors logged. Alternatively, callers may retrieve the entire log as
* an SBMLErrorLog object using the method SBMLDocument::getErrorLog().
@@ -357,11 +356,13 @@
* object has no associated XML attributes, including (but not limited
* to) an XML namespace declaration. The XML namespace declaration is
* not added until the model is written out, <em>or</em> the method
- * @if clike SBMLDocument::setLevelAndVersion() @endif@... python SBMLDocument::setLevelAndVersion() @endif@... java SBMLDocument::setLevelAndVersion(long lev, long ver, boolean strict) @endif is called. This may be important to keep in mind
+ * SBMLDocument::setLevelAndVersion(@if java long lev, long ver, boolean strict@...)
+ * is called. This may be important to keep in mind
* if an application needs to add additional XML namespace declarations
* on the <code><sbml></code> element. Application writers should
* either provide values for @p level and @p version on the call to this
- * constructor, or else call @if clike SBMLDocument::setLevelAndVersion() @endif@... python SBMLDocument::setLevelAndVersion() @endif@... java SBMLDocument::setLevelAndVersion(long lev, long ver, boolean strict) @endif shortly after creating
+ * constructor, or else call
+ * SBMLDocument::setLevelAndVersion(@if java long lev, long ver, boolean strict@...) shortly after creating
* the SBMLDocument object.
*
* @param level an integer for the SBML Level
@@ -370,7 +371,7 @@
*
* @if notcpp @docnote @htmlinclude warn-default-args-in-docs.html @endif
*
- * @if clike @see SBMLDocument::setLevelAndVersion() @endif@... python @see SBMLDocument::setLevelAndVersion() @endif@... java @see SBMLDocument::setLevelAndVersion(long lev, long ver, boolean strict) @endif
+ * @see SBMLDocument::setLevelAndVersion(@if java long lev, long ver, boolean strict@...)
* @see getDefaultLevel()
* @see getDefaultVersion()
*/
@@ -393,8 +394,7 @@
* (identifier) attribute of a Compartment is required to have a value.
* Thus, callers are cautioned to assign a value after calling this
* constructor. Setting the identifier can be accomplished using the
- * method
- * @if clike setId()@endif@... python setId()@endif@... java Compartment::setId(String id)@endif.
+ * method Compartment::setId(@if java String id@...).
*
* @param sbmlns an SBMLNamespaces object.
*
@@ -454,7 +454,7 @@
* It is important to note that this method <em>does not create</em> a
* Model instance. The model in the SBMLDocument must have been created
* at some prior time, for example using SBMLDocument::createModel()
- * or @if clike SBMLDocument::setModel() @endif@... python SBMLDocument::setModel() @endif@... java SBMLDocument::setModel(Model m) @endif.
+ * or SBMLDocument::setModel(@if java Model m@...).
* This method returns @c NULL if a model does not yet exist.
*
* @return the Model contained in this SBMLDocument.
@@ -470,7 +470,7 @@
* It is important to note that this method <em>does not create</em> a
* Model instance. The model in the SBMLDocument must have been created
* at some prior time, for example using SBMLDocument::createModel()
- * or @if clike SBMLDocument::setModel() @endif@... python SBMLDocument::setModel() @endif@... java SBMLDocument::setModel(Model m) @endif.
+ * or SBMLDocument::setModel(@if java Model m@...).
* This method returns @c NULL if a model does not yet exist.
*
* @return the Model contained in this SBMLDocument.
@@ -635,7 +635,7 @@
* @if notcpp @docnote @htmlinclude warn-default-args-in-docs.html @endif
*
* @see getModel()
- * @see @if clike SBMLDocument::setModel() @endif@... python SBMLDocument::setModel() @endif@... java SBMLDocument::setModel(Model m) @endif
+ * @see SBMLDocument::setModel(@if java Model m@...)
*/
Model* createModel (const std::string& sid = "");
@@ -714,16 +714,20 @@
* </ul>
*
* <em>By default, all validation checks are applied</em> to the model in
- * an SBMLDocument object @em unless @if clike SBMLDocument::setConsistencyChecks() @endif@... python SBMLDocument::setConsistencyChecks() @endif@... java SBMLDocument::setConsistencyChecks(int categ, boolean onoff) @endif is called to
- * indicate that only a subset should be applied. Further, this default
- * (i.e., performing all checks) applies separately to <em>each new
- * SBMLDocument object</em> created. In other words, each time a model
- * is read using @if clike SBMLReader::readSBML() @endif@... python SBMLReader::readSBML() @endif@... java SBMLReader::readSBML(String filename) @endif, @if clike SBMLReader::readSBMLFromString() @endif@... python SBMLReader::readSBMLFromString() @endif@... java SBMLReader::readSBMLFromString(String xml) @endif,
+ * an SBMLDocument object @em unless
+ * SBMLDocument::setConsistencyChecks(@if java int categ, boolean onoff@...)
+ * is called to indicate that only a subset should be applied. Further,
+ * this default (i.e., performing all checks) applies separately to
+ * <em>each new SBMLDocument object</em> created. In other words, each
+ * time a model is read using SBMLReader::readSBML(@if java String filename@...),
+ * SBMLReader::readSBMLFromString(@if java String xml@...),
* or the global functions readSBML() and readSBMLFromString(), a new
* SBMLDocument is created and for that document, a call to
* SBMLDocument::checkConsistency() will default to applying all possible checks.
- * Calling programs must invoke @if clike SBMLDocument::setConsistencyChecks() @endif@... python SBMLDocument::setConsistencyChecks() @endif@... java SBMLDocument::setConsistencyChecks(int categ, boolean onoff) @endif for each such new
- * model if they wish to change the consistency checks applied.
+ * Calling programs must invoke
+ * SBMLDocument::setConsistencyChecks(@if java int categ, boolean onoff@...)
+ * for each such new model if they wish to change the consistency checks
+ * applied.
*
* @param category a value drawn from #SBMLErrorCategory_t indicating the
* consistency checking/validation to be turned on or off
@@ -810,16 +814,20 @@
* </ul>
*
* <em>By default, all validation checks are applied</em> to the model in
- * an SBMLDocument object @em unless @if clike SBMLDocument::setConsistencyChecks() @endif@... python SBMLDocument::setConsistencyChecks() @endif@... java SBMLDocument::setConsistencyChecks(int categ, boolean onoff) @endif is called to
- * indicate that only a subset should be applied. Further, this default
- * (i.e., performing all checks) applies separately to <em>each new
- * SBMLDocument object</em> created. In other words, each time a model
- * is read using @if clike SBMLReader::readSBML() @endif@... python SBMLReader::readSBML() @endif@... java SBMLReader::readSBML(String filename) @endif, @if clike SBMLReader::readSBMLFromString() @endif@... python SBMLReader::readSBMLFromString() @endif@... java SBMLReader::readSBMLFromString(String xml) @endif,
+ * an SBMLDocument object @em unless
+ * SBMLDocument::setConsistencyChecks(@if java int categ, boolean onoff@...)
+ * is called to indicate that only a subset should be applied. Further,
+ * this default (i.e., performing all checks) applies separately to
+ * <em>each new SBMLDocument object</em> created. In other words, each
+ * time a model is read using SBMLReader::readSBML(@if java String filename@...),
+ * SBMLReader::readSBMLFromString(@if java String xml@...),
* or the global functions readSBML() and readSBMLFromString(), a new
* SBMLDocument is created and for that document, a call to
* SBMLDocument::checkConsistency() will default to applying all possible checks.
- * Calling programs must invoke @if clike SBMLDocument::setConsistencyChecks() @endif@... python SBMLDocument::setConsistencyChecks() @endif@... java SBMLDocument::setConsistencyChecks(int categ, boolean onoff) @endif for each such new
- * model if they wish to change the consistency checks applied.
+ * Calling programs must invoke
+ * SBMLDocument::setConsistencyChecks(@if java int categ, boolean onoff@...)
+ * for each such new model if they wish to change the consistency checks
+ * applied.
*
* @param category a value drawn from #SBMLErrorCategory_t indicating the
* consistency checking/validation to be turned on or off
@@ -827,7 +835,7 @@
* @param apply a boolean indicating whether the checks indicated by
* @p category should be applied or not.
*
- * @see @if clike SBMLDocument::setLevelAndVersion() @endif@... python SBMLDocument::setLevelAndVersion() @endif@... java SBMLDocument::setLevelAndVersion(long lev, long ver, boolean strict) @endif
+ * @see SBMLDocument::setLevelAndVersion(@if java long lev, long ver, boolean strict@...)
*/
void setConsistencyChecksForConversion(SBMLErrorCategory_t category,
bool apply);
@@ -840,7 +848,7 @@
* consistency checks have failed for SBML document), the failures may be
* due to warnings @em or errors. Callers should inspect the severity
* flag in the individual SBMLError objects returned by
- * @if clike SBMLDocument::getError() @endif@... python SBMLDocument::getError() @endif@... java SBMLDocument::getError(long n) @endif to determine the nature of the failures.
+ * SBMLDocument::getError(@if java long n@...) to determine the nature of the failures.
*
* @return the number of failed checks (errors) encountered.
*
@@ -854,7 +862,7 @@
* an SBML Model.
*
* Callers should query the results of the consistency check by calling
- * @if clike SBMLDocument::getError() @endif@... python SBMLDocument::getError() @endif@... java SBMLDocument::getError(long n) @endif.
+ * SBMLDocument::getError(@if java long n@...).
*
* @return the number of failed checks (errors) encountered.
*
@@ -877,7 +885,7 @@
* to Level 1.
*
* Callers should query the results of the consistency check by calling
- * @if clike SBMLDocument::getError() @endif@... python SBMLDocument::getError() @endif@... java SBMLDocument::getError(long n) @endif.
+ * SBMLDocument::getError(@if java long n@...).
*
* @return the number of failed checks (errors) encountered.
*/
@@ -890,7 +898,7 @@
* be converted to Level 2 Version 1.
*
* Callers should query the results of the consistency check by calling
- * @if clike SBMLDocument::getError() @endif@... python SBMLDocument::getError() @endif@... java SBMLDocument::getError(long n) @endif.
+ * SBMLDocument::getError(@if java long n@...).
*
* @return the number of failed checks (errors) encountered.
*/
@@ -903,7 +911,7 @@
* be converted to Level 2 Version 2.
*
* Callers should query the results of the consistency check by calling
- * @if clike SBMLDocument::getError() @endif@... python SBMLDocument::getError() @endif@... java SBMLDocument::getError(long n) @endif.
+ * SBMLDocument::getError(@if java long n@...).
*
* @return the number of failed checks (errors) encountered.
*/
@@ -916,7 +924,7 @@
* be converted to Level 2 Version 3.
*
* Callers should query the results of the consistency check by calling
- * @if clike SBMLDocument::getError() @endif@... python SBMLDocument::getError() @endif@... java SBMLDocument::getError(long n) @endif.
+ * SBMLDocument::getError(@if java long n@...).
*
* @return the number of failed checks (errors) encountered.
*/
@@ -929,7 +937,7 @@
* be converted to Level 2 Version 4.
*
* Callers should query the results of the consistency check by calling
- * @if clike SBMLDocument::getError() @endif@... python SBMLDocument::getError() @endif@... java SBMLDocument::getError(long n) @endif.
+ * SBMLDocument::getError(@if java long n@...).
*
* @return the number of failed checks (errors) encountered.
*/
@@ -942,7 +950,7 @@
* be converted to Level 3 Version 1.
*
* Callers should query the results of the consistency check by calling
- * @if clike SBMLDocument::getError() @endif@... python SBMLDocument::getError() @endif@... java SBMLDocument::getError(long n) @endif.
+ * SBMLDocument::getError(@if java long n@...).
*
* @return the number of failed checks (errors) encountered.
*/
Modified: trunk/libsbml/src/sbml/SBMLError.h
===================================================================
--- trunk/libsbml/src/sbml/SBMLError.h 2011-02-27 05:14:17 UTC (rev 13062)
+++ trunk/libsbml/src/sbml/SBMLError.h 2011-02-27 05:16:27 UTC (rev 13063)
@@ -1054,7 +1054,7 @@
* filled-in as well from the enumerations <a class="el"
* href="#SBMLErrorSeverity_t">SBMLErrorSeverity_t</a> and <a class="el"
* href="#SBMLErrorCategory_t">SBMLErrorCategory_t</a>,
- * respectively. @endif@... notcpp set of constants. If it @em
+ * respectively. @else set of constants. If it @em
* is one of the predefined error identifiers, the SBMLError class
* assumes the error is a low-level system or SBML layer error and
* <em>prepends</em> a built-in, predefined error message to any string
@@ -1087,7 +1087,7 @@
* href="#SBMLErrorSeverity_t">SBMLErrorSeverity_t</a> and <a class="el"
* href="#SBMLErrorCategory_t">SBMLErrorCategory_t</a>, but their own
* special values) for @p severity and
- * @p category. @endif@... notcpp As mentioned above,
+ * @p category. @else As mentioned above,
* there are additional constants defined for <a class="el"
* href="#SBMLErrorSeverity_t">standard severity</a> and <a class="el"
* href="#SBMLErrorCategory_t">standard category</a> codes, and every predefined
Modified: trunk/libsbml/src/sbml/SBMLErrorLog.h
===================================================================
--- trunk/libsbml/src/sbml/SBMLErrorLog.h 2011-02-27 05:14:17 UTC (rev 13062)
+++ trunk/libsbml/src/sbml/SBMLErrorLog.h 2011-02-27 05:16:27 UTC (rev 13063)
@@ -43,18 +43,18 @@
* SBMLErrorLog is derived from XMLErrorLog, an object class that serves
* exactly the same purpose but for the XML parsing layer. XMLErrorLog
* provides crucial methods such as
- * @if clike getNumErrors()@endif@... python getNumErrors()@endif@... java XMLErrorLog::getNumErrors()@endif
+ * @if java XMLErrorLog::getNumErrors()@else getNumErrors()@endif
* for determining how many SBMLError or XMLError objects are in the log.
* SBMLErrorLog inherits these methods.
*
* The general approach to working with SBMLErrorLog in user programs
* involves first obtaining a pointer to a log from a libSBML object such
* as SBMLDocument. Callers should then use
- * @if clike getNumErrors()@endif@... python getNumErrors()@endif@... java XMLErrorLog::getNumErrors()@endif to inquire how
+ * @if java XMLErrorLog::getNumErrors()@else getNumErrors()@endif to inquire how
* many objects there are in the list. (The answer may be 0.) If there is
* at least one SBMLError object in the SBMLErrorLog instance, callers can
* then iterate over the list using
- * @if clike getError(unsigned int)@endif@... python getError(unsigned int)@endif@... java SBMLErrorLog::getError(long n)@endif@... clike const@...,
+ * SBMLErrorLog::getError(@if java long n@... clike const@...,
* using methods provided by the SBMLError class to find out the error code
* and associated information such as the error severity, the message, and
* the line number in the input.
@@ -90,7 +90,7 @@
*
* Index @p n is counted from 0. Callers should first inquire about the
* number of items in the log by using the
- * @if clike getNumErrors()@endif@... python getNumErrors()@endif@... java XMLErrorLog::getNumErrors()@endif method.
+ * @if java XMLErrorLog::getNumErrors()@else getNumErrors()@endif method.
* Attempts to use an error index number that exceeds the actual number
* of errors in the log will result in a @c NULL being returned.
*
@@ -99,7 +99,7 @@
*
* @return the <i>n</i>th SBMLError in this log, or @c NULL if @p n is
* greater than or equal to
- * @if clike getNumErrors()@endif@... python getNumErrors()@endif@... java XMLErrorLog::getNumErrors()@endif.
+ * @if java XMLErrorLog::getNumErrors()@else getNumErrors()@endif.
*
* @see getNumErrors()
*/
Modified: trunk/libsbml/src/sbml/SBMLNamespaces.h
===================================================================
--- trunk/libsbml/src/sbml/SBMLNamespaces.h 2011-02-27 05:14:17 UTC (rev 13062)
+++ trunk/libsbml/src/sbml/SBMLNamespaces.h 2011-02-27 05:16:27 UTC (rev 13063)
@@ -253,7 +253,7 @@
// Handle another truly exceptional situation.
}
@endverbatim
-@... java
+ * @endif@... java
@verbatim
SBMLDocument sd;
try
@@ -276,9 +276,9 @@
else
{
// Handle another truly exceptional situation.
-}
+ }
@endverbatim
-@...
+ * @endif
*
* @param xmlns the XML namespaces to be added.
*/
Modified: trunk/libsbml/src/sbml/SBMLReader.h
===================================================================
--- trunk/libsbml/src/sbml/SBMLReader.h 2011-02-27 05:14:17 UTC (rev 13062)
+++ trunk/libsbml/src/sbml/SBMLReader.h 2011-02-27 05:16:27 UTC (rev 13063)
@@ -46,12 +46,12 @@
*
* For convenience as well as easy access from other languages besides C++,
* this file also defines two global functions,
- * @if clike readSBMLFromFile()@endif@... python readSBMLFromFile()@endif@... java libsbml::readSBML(String filename)@endif
- * and @if clike readSBMLFromString()@endif@... python readSBMLFromString()@endif@... java libsbml::readSBMLFromString(String xml)@endif.
+ * libsbml::readSBML(@if java String filename@...)
+ * and libsbml::readSBMLFromString(@if java String xml@...).
* They are equivalent to creating an SBMLReader
* object and then calling the
- * @if clike SBMLReader::readSBML()@endif@... python SBMLReader::readSBML()@endif@... java SBMLReader::readSBML(String filename)@endif or
- * @if clike SBMLReader::readSBMLFromString()@endif@... python SBMLReader::readSBMLFromString()@endif@... java SBMLReader::readSBMLFromString(String xml)@endif
+ * SBMLReader::readSBML(@if java String filename@...) or
+ * SBMLReader::readSBMLFromString(@if java String xml@...)
* methods, respectively.
*
* @section compression Support for reading compressed files
@@ -72,8 +72,8 @@
* zip formats) and/or @em bzip2 (for @em bzip2 format) be available on the
* system running libSBML, and that libSBML was configured with their
* support compiled-in. Please see the libSBML @if clike <a href="libsbml-installation.html">installation instructions</a> @endif@... python <a href="libsbml-installation.html">installation instructions</a> @endif@... java <a href="../../../libsbml-installation.html">installation instructions</a> @endif for more information about this. The methods
- * @if clike hasZlib()@endif@... python hasZlib()@endif@... java SBMLReader::hasZlib()@endif and
- * @if clike hasBzip2()@endif@... python hasBzip2()@endif@... java SBMLReader::hasBzip2()@endif
+ * @if java SBMLReader::hasZlib()@else hasZlib()@endif and
+ * @if java SBMLReader::hasBzip2()@else hasBzip2()@endif
* can be used by an application to query at run-time whether support
* for the compression libraries is available in the present copy of
* libSBML.
@@ -130,8 +130,8 @@
* valid SBML, one or more errors will be logged with the SBMLDocument
* object returned by this method. Callers can use the methods on
* SBMLDocument such as SBMLDocument::getNumErrors() and
- * @if clike SBMLDocument::getError() @endif@... python SBMLDocument::getError() @endif@... java SBMLDocument::getError(long n) @endif to get the errors. The object returned by
- * @if clike SBMLDocument::getError() @endif@... python SBMLDocument::getError() @endif@... java SBMLDocument::getError(long n) @endif is an SBMLError object, and it has methods to
+ * SBMLDocument::getError(@if java long n@...) to get the errors. The object returned by
+ * SBMLDocument::getError(@if java long n@...) is an SBMLError object, and it has methods to
* get the error code, category, and severity level of the problem, as
* well as a textual description of the problem. The possible severity
* levels range from informational messages to fatal errors; see the
@@ -146,63 +146,63 @@
* by the underlying operating system. Callers can check for these
* situations using a program fragment such as the following:
* @if clike
-@...
-SBMLReader* reader = new SBMLReader();
-SBMLDocument* doc = reader.readSBMLFromFile(filename);
-
-if (doc->getNumErrors() > 0)
-{
- if (doc->getError(0)->getErrorId() == XMLError::FileUnreadable)
- {
- // Handle case of unreadable file here.
- }
- else if (doc->getError(0)->getErrorId() == XMLError::FileOperationError)
- {
- // Handle case of other file operation error here.
- }
- else
- {
- // Handle other cases -- see error codes defined in XMLErrorCode_t
- // for other possible cases to check.
- }
-}
-@...
-@... java
-@...
-SBMLReader reader = new SBMLReader();
-SBMLDocument doc = reader.readSBMLFromFile(filename);
-
-if (doc.getNumErrors() > 0)
-{
- if (doc.getError(0).getErrorId() == libsbmlConstants.XMLFileUnreadable)
- {
- // Handle case of unreadable file here.
- }
- else if (doc.getError(0).getErrorId() == libsbmlConstants.XMLFileOperationError)
- {
- // Handle case of other file operation error here.
- }
- else
- {
- // Handle other error cases.
- }
-}
-@...
-@... python
-@...
-reader = SBMLReader()
-doc = reader.readSBMLFromFile(filename)
-
-if doc.getNumErrors() > 0:
- if doc.getError(0).getErrorId() == libsbml.XMLFileUnreadable:
- # Handle case of unreadable file here.
- elif doc.getError(0).getErrorId() == libsbml.XMLFileOperationError:
- # Handle case of other file error here.
- else:
- # Handle other error cases here.
-
-@...
-@...
+ @verbatim
+ SBMLReader* reader = new SBMLReader();
+ SBMLDocument* doc = reader.readSBMLFromFile(filename);
+
+ if (doc->getNumErrors() > 0)
+ {
+ if (doc->getError(0)->getErrorId() == XMLError::FileUnreadable)
+ {
+ // Handle case of unreadable file here.
+ }
+ else if (doc->getError(0)->getErrorId() == XMLError::FileOperationError)
+ {
+ // Handle case of other file operation error here.
+ }
+ else
+ {
+ // Handle other cases -- see error codes defined in XMLErrorCode_t
+ // for other possible cases to check.
+ }
+ }
+ @endverbatim
+ @endif@... java
+ @verbatim
+ SBMLReader reader = new SBMLReader();
+ SBMLDocument doc = reader.readSBMLFromFile(filename);
+
+ if (doc.getNumErrors() > 0)
+ {
+ if (doc.getError(0).getErrorId() == libsbmlConstants.XMLFileUnreadable)
+ {
+ // Handle case of unreadable file here.
+ }
+ else if (doc.getError(0).getErrorId() == libsbmlConstants.XMLFileOperationError)
+ {
+ // Handle case of other file operation error here.
+ }
+ else
+ {
+ // Handle other error cases.
+ }
+ }
+ @endverbatim
+ @endif@... python
+ @verbatim
+ reader = SBMLReader()
+ doc = reader.readSBMLFromFile(filename)
+
+ if doc.getNumErrors() > 0:
+ if doc.getError(0).getErrorId() == libsbml.XMLFileUnreadable:
+ # Handle case of unreadable file here.
+ elif doc.getError(0).getErrorId() == libsbml.XMLFileOperationError:
+ # Handle case of other file error here.
+ else:
+ # Handle other error cases here.
+
+ @endverbatim
+ @endif
*
* If the given filename ends with the suffix @c ".gz" (for example, @c
* "myfile.xml.gz"), the file is assumed to be compressed in @em gzip
@@ -250,8 +250,8 @@
* valid SBML, one or more errors will be logged with the SBMLDocument
* object returned by this method. Callers can use the methods on
* SBMLDocument such as SBMLDocument::getNumErrors() and
- * @if clike SBMLDocument::getError() @endif@... python SBMLDocument::getError() @endif@... java SBMLDocument::getError(long n) @endif to get the errors. The object returned by
- * @if clike SBMLDocument::getError() @endif@... python SBMLDocument::getError() @endif@... java SBMLDocument::getError(long n) @endif is an SBMLError object, and it has methods to
+ * SBMLDocument::getError(@if java long n@...) to get the errors. The object returned by
+ * SBMLDocument::getError(@if java long n@...) is an SBMLError object, and it has methods to
* get the error code, category, and severity level of the problem, as
* well as a textual description of the problem. The possible severity
* levels range from informational messages to fatal errors; see the
@@ -266,63 +266,63 @@
* by the underlying operating system. Callers can check for these
* situations using a program fragment such as the following:
* @if clike
-@...
-SBMLReader* reader = new SBMLReader();
-SBMLDocument* doc = reader.readSBML(filename);
-
-if (doc->getNumErrors() > 0)
-{
- if (doc->getError(0)->getErrorId() == XMLError::FileUnreadable)
- {
- // Handle case of unreadable file here.
- }
- else if (doc->getError(0)->getErrorId() == XMLError::FileOperationError)
- {
- // Handle case of other file operation error here.
- }
- else
- {
- // Handle other cases -- see error codes defined in XMLErrorCode_t
- // for other possible cases to check.
- }
-}
-@...
-@... java
-@...
-SBMLReader reader = new SBMLReader();
-SBMLDocument doc = reader.readSBMLFromFile(filename);
-
-if (doc.getNumErrors() > 0)
-{
- if (doc.getError(0).getErrorId() == libsbmlConstants.XMLFileUnreadable)
- {
- // Handle case of unreadable file here.
- }
- else if (doc.getError(0).getErrorId() == libsbmlConstants.XMLFileOperationError)
- {
- // Handle case of other file operation error here.
- }
- else
- {
- // Handle other error cases.
- }
-}
-@...
-@... python
-@...
-reader = SBMLReader()
-doc = reader.readSBMLFromFile(filename)
-
-if doc.getNumErrors() > 0:
- if doc.getError(0).getErrorId() == libsbml.XMLFileUnreadable:
- # Handle case of unreadable file here.
- elif doc.getError(0).getErrorId() == libsbml.XMLFileOperationError:
- # Handle case of other file error here.
- else:
- # Handle other error cases here.
-
-@...
-@...
+ @verbatim
+ SBMLReader* reader = new SBMLReader();
+ SBMLDocument* doc = reader.readSBML(filename);
+
+ if (doc->getNumErrors() > 0)
+ {
+ if (doc->getError(0)->getErrorId() == XMLError::FileUnreadable)
+ {
+ // Handle case of unreadable file here.
+ }
+ else if (doc->getError(0)->getErrorId() == XMLError::FileOperationError)
+ {
+ // Handle case of other file operation error here.
+ }
+ else
+ {
+ // Handle other cases -- see error codes defined in XMLErrorCode_t
+ // for other possible cases to check.
+ }
+ }
+ @endverbatim
+ @endif@... java
+ @verbatim
+ SBMLReader reader = new SBMLReader();
+ SBMLDocument doc = reader.readSBMLFromFile(filename);
+
+ if (doc.getNumErrors() > 0)
+ {
+ if (doc.getError(0).getErrorId() == libsbmlConstants.XMLFileUnreadable)
+ {
+ // Handle case of unreadable file here.
+ }
+ else if (doc.getError(0).getErrorId() == libsbmlConstants.XMLFileOperationError)
+ {
+ // Handle case of other file operation error here.
+ }
+ else
+ {
+ // Handle other error cases.
+ }
+ }
+ @endverbatim
+ @endif@... python
+ @verbatim
+ reader = SBMLReader()
+ doc = reader.readSBMLFromFile(filename)
+
+ if doc.getNumErrors() > 0:
+ if doc.getError(0).getErrorId() == libsbml.XMLFileUnreadable:
+ # Handle case of unreadable file here.
+ elif doc.getError(0).getErrorId() == libsbml.XMLFileOperationError:
+ # Handle case of other file error here.
+ else:
+ # Handle other error cases here.
+
+ @endverbatim
+ @endif
*
* If the given filename ends with the suffix @c ".gz" (for example, @c
* "myfile.xml.gz"), the file is assumed to be compressed in @em gzip
@@ -373,14 +373,14 @@
*
* This method will log a fatal error if the content given in the
* parameter @p xml is not SBML. See the method documentation for
- * @if clike SBMLReader::readSBML()@endif@... python SBMLReader::readSBML()@endif@... java SBMLReader::readSBML(String filename)@endif
+ * SBMLReader::readSBML(@if java String filename@...)
* for an example of code for testing the returned error code.
*
* @param xml a string containing a full SBML model
*
* @return a pointer to the SBMLDocument created from the SBML content.
*
- * @if clike @see SBMLReader::readSBML()@endif@... python @see SBMLReader::readSBML()@endif@... java @see SBMLReader::readSBML(String filename)@endif
+ * @see SBMLReader:@if java :readSBML(String filename@...)
*/
SBMLDocument* readSBMLFromString (const std::string& xml);
Modified: trunk/libsbml/src/sbml/SBMLWriter.h
===================================================================
--- trunk/libsbml/src/sbml/SBMLWriter.h 2011-02-27 05:14:17 UTC (rev 13062)
+++ trunk/libsbml/src/sbml/SBMLWriter.h 2011-02-27 05:16:27 UTC (rev 13063)
@@ -60,8 +60,8 @@
* system running libSBML, and that libSBML was configured with their
* support compiled-in. Please see the libSBML @if clike <a href="libsbml-installation.html">installation instructions</a>@endif@... python <a href="libsbml-installation.html">installation instructions</a>@endif@... java <a href="../../../libsbml-installation.html">installation instructions</a>@endif for
* more information about this. The methods
- * @if clike hasZlib()@endif@... python hasZlib()@endif@... java SBMLWriter::hasZlib()@endif and
- * @if clike hasBzip2()@endif@... python hasBzip2()@endif@... java SBMLWriter::hasBzip2()@endif
+ * SBMLWriter::hasZlib() and
+ * SBMLWriter::hasBzip2()
* can be used by an application to query at run-time whether support
* for the compression libraries is available in the present copy of
* libSBML.
@@ -114,7 +114,7 @@
* write out the SBMLDocument.
*
* If the program name and version are set (see
- * @if clike setProgramVersion()@endif@... python setProgramVersion()@endif@... java SBMLWriter::setProgramVersion(String version)@endif), the
+ * SBMLWriter::setProgramVersion(@if java String version@...)), the
* following XML comment, intended for human consumption, will be written
* at the beginning of the XML document:
* @verbatim
@@ -143,7 +143,7 @@
* write out the SBMLDocument.
*
* If the program version and name are set (see
- * @if clike setProgramName()@endif@... python setProgramName()@endif@... java SBMLWriter::setProgramName(String name)@endif), the
+ * SBMLWriter::setProgramName(@if java String name@...)), the
* following XML comment, intended for human consumption, will be written
* at the beginning of the document:
* @verbatim
@@ -449,8 +449,8 @@
* should be freed (with the normal string <code>free()</code> C++
* function) after it is no longer needed.@...
*
- * @if clike @see hasZlib()@endif@... python @see hasZlib()@endif@... java @see SBMLWriter::hasZlib()@endif
- * @if clike @see hasBzip2()@endif@... python @see hasBzip2()@endif@... java @see SBMLWriter::hasBzip2()@endif
+ * @see SBMLWriter::hasZlib()
+ * @see SBMLWriter::hasBzip2()
*/
LIBSBML_EXTERN
int
@@ -505,8 +505,8 @@
* should be freed (with the normal string <code>free()</code> C++
* function) after it is no longer needed.@...
*
- * @if clike @see hasZlib()@endif@... python @see hasZlib()@endif@... java @see SBMLWriter::hasZlib()@endif
- * @if clike @see hasBzip2()@endif@... python @see hasBzip2()@endif@... java @see SBMLWriter::hasBzip2()@endif
+ * @see SBMLWriter::hasZlib()
+ * @see SBMLWriter::hasBzip2()
*/
LIBSBML_EXTERN
int
Modified: trunk/libsbml/src/sbml/SBase.h
===================================================================
--- trunk/libsbml/src/sbml/SBase.h 2011-02-27 05:14:17 UTC (rev 13062)
@@ Diff output truncated at 100000 characters. @@
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
|