Package net.simplace.core.doc
package net.simplace.core.doc
Creation of the SIMPLACE documentation: javadoc with the documentation of the SimComponents and resource
transformers (wiki text, formulas, variable tables), independent of a build tool. Entry point is
DocGenerator.-
ClassesClassDescriptionPrepares the doc comments of a Java source file for the standard javadoc tool: wiki blocks (the result of
CommentPreprocessor.process(String, String, String)Creates the documentation page of a single SimComponent or resource transformer at runtime, e.g.Creates the javadoc of SIMPLACE source trees with the documentation of the SimComponents and resource transformers, independently of a build tool (console, HPC, Eclipse launch configuration, ant, Maven, ...).Build step: writes the class comments of the SimComponents and resource transformers of a source tree as resources<SimpleName>.simdocnext to the compiled classes, so that the documentation page can be created at runtime from a jar (seeComponentDocPage).Creates the HTML table of the variables of a SimComponent or resource transformer, as shown in the documentation (sortable, one row per variable, private variables omitted).Converts the TracWiki markup of documentation texts to HTML.