
I'd like to be able to (optionally?) write the documentation in some sort of markdown-format, which is then converted into the traditional .xml format to be used for the build.
For example, I have generated this file from this format.
PS: that would additionally be an opportunity to add a decent "related functions" section based on tags and to be able to add certain remarks at a central place to multiple functions (i.e.
"For a detailed exaplanation see the GUI docs."
for GuiOpen/Close/Update etc.)


The "related functions" section is annoying. It's almost impossible to maintain. The only time is useful is when you add links to other parts of the documentation, e.g. linking the object category documentation from GetCategory(). Otherwise, smart sorting into categories is the better solution. I don't know if multiple tags are even needed.
Edit: 8
Powered by mwForum 2.29.7 © 1999-2015 Markus Wichitill