On 2014-08-22 13:45, Patrick Goupell wrote: > What kind of documentation would you most like to see?
With fpdoc you can cater for both. FPDoc allows example code and images to be included with the documentation. For example, the URL's below shows documentation of a unit that is part of the tiOPF project. Documented using FPDoc's XML format, then HTML output generated. Unit overview: Describes feature a specific unit supplies etc. http://opensoft.homeip.net/tiopf/core/titokenlibrary/index.html Class overview: Which includes method descriptions, inheritance tree, description with an accompanied image, and an example of usage section. http://opensoft.homeip.net/tiopf/core/titokenlibrary/ttokens.html The above shows the HTML output (the look can be configured with CSS), but you can also tell fpdoc to generate that same help content as PDF, INF, CHM etc. So is very useful. FPDoc also allows for "Additional Topics" or "Related Topics" which can be assigned to a package, unit, class etc. They are a free-form page that can describe any topic. http://fpgui.sourceforge.net/apidocs/additionaltopics.html Regards, - Graeme - -- fpGUI Toolkit - a cross-platform GUI toolkit using Free Pascal http://fpgui.sourceforge.net/ ------------------------------------------------------------------------------ Slashdot TV. Video for Nerds. Stuff that matters. http://tv.slashdot.org/ _______________________________________________ mseide-msegui-talk mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/mseide-msegui-talk
