Next: Special statements Up: Documenting solved problems and Previous: The documentation system

The documentation statements

The documentation statements are placed directly in the problem file together with the input data in the case of documents for problems solved by DYNAST. In the case of documents for DYNAST submodels, the statements are placed directly in the submodel data files.

The documentation statements are denoted by colon characters, respecting the following rules:

text between a colon (:) and the end of the line is treated as a comment and ignored both by the solver and by the documentation system
a text to the right of a double colon (::) provides more detailed information for the statement preceding these two characters (e.g., the description of a parameter or of a submodel interface)
the triple colon (:::) indicates that the text to the right of it on the same line is either a documentation statement or a text in L^ATEX format