KerMor  0.9
Model order reduction for nonlinear dynamical systems and nonlinear approximation
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
Documentation creation

Guidlines for creating and maintaining this documentation

KerMor uses the FEX submission "mtoc++ - Doxygen filter for Matlab and tools" http://www.mathworks.com/matlabcentral/fileexchange/33826 to create the documentation using doxygen. Once KerMor is installed you can create the KerMor documentation by calling

MatlabDocMaker.create

from within MatLab. That's it!

Please see the documentation on the MatlabDocMaker for detailed options.

Please refer to the Required documentation updates site to see where the current documentation is outdated or not yet written.

Developer information: Complete file list of documentation creation related files

This section contains information for KerMor developers.

The following list of files gives a short overview about their individual role:

  • development.c - Documentation for active developers
  • DocumentationGuide - This is an example class showing how to document matlab classes in order to have them displayed most sensibly using doxygen.
  • Doxyfile.template - The configuration file for doxygen. Is preprocessed to insert correct paths.
  • doxygen_todo.m - A matlab file containing some tasks yet to investigate regarding the doxygen documentation creation.
  • class_substitute.c - A C file that contains a fake handle class description as the native matlab handle class is not found/parsed by doxygen.
  • kermor.jpg - The logo of KerMor
  • mathjax_cmds - MathJax inclusion for dynamic latex parsing in the HTML output
  • latexextras.template - The style file included into the _formulas.tex file when latex is run. Add any additional package declarations here (or in Commands.tex) Will be preprocessed for correct path substitution.
  • mainpage.c - The main page source documentation file
  • newfeat_changelog.c - The manual source files for the changelog pages
  • mtocpp.conf - The mtoc++-configuration for this project
  • quality.c - Notes on how to ensure/support simulation quality with KerMor
  • scaling.c - Explanation of scaling in KerMor
  • literature.bib - BibTex database for references used in KerMor documentation