Started out looking at the use of Restructured text. It is somewhat involved to get started so documenting the steps and will report back.
Continuing exploration of the native support that front-line programming languages offer to document the functionality of code. Now looking at DOxygen. The programming language support per the User Manual includes: the following C, C++, C#, Objective-C, IDL, Java, VHDL, PHP, Python, Tcl, Fortran, and D.
Of course lots of other documentation support within programming languages: Here is a quote from this Wikipedia site: https://en.wikipedia.org/wiki/Software_documentation
“Often, tools such as Doxygen, NDoc, Visual Expert, Javadoc, EiffelStudio, Sandcastle, ROBODoc, POD, TwinText, or Universal Report can be used to auto-generate the code documents—that is, they extract the comments and software contracts, where available, from the source code and create reference manuals in such forms as text or HTML files.”
Is there anything to learn from all this. Who knows?
Leave a Reply