Description

mfront-doc allows the user to extract the documentation out of MFront file. mfront-doc generates files in pandoc markdown format. Those files can be processed using pandoc and be converted to one of the many file format supported by pandoc, including LaTeX, html or various Word processor formats: Microsoft Word docx, OpenOffice/LibreOffice ODT.

Two kinds of documentations can be generated from mfront-doc:

• The web documentation generates a file containing a shorter description of the MFront file followed by the content of intial file. This documentation is usefull for creating web pages describing the content of a material management project.
• The full documentation gives a full description of the MFront file. It contains in particular the whole description of the inputs of the behaviours and the default values of the parameters.

A minimalistic Example

The web documentation generated from the Norton.mfront file can be found:

• in html format here.
• in docx format here.
• in odt format here.
• in pdf format here.

The full documentation generated from the same file can be found:

• in html format here.
• in docx format here.
• in odt format here.
• in pdf format here.