[hemmerling] Software Documentation

Graphical Description Notations for Description of Systems

Atom "Docblockr Package" - Code documentation for “ActionScript, C, C++,, Cuda-C++, CoffeeScript, Groovy, Haxe, Java, JavaScript, ObjC, ObjC++, Php, Rust, TypeScript”.

DOC++ ( Sourceforge "DOC++", Sourceforge "DOC++" ) - a documentation system for C, C++, IDL and Java generating both TeX output for high quality hardcopies and HTML output for sophisticated online browsing of your documentation.

Doxygen ( Doxygen, Sourceforge "Doxygen", Sourceforge "Doxygen" ) - free Open Source documentation system for C++, C, Java, Objective-C, Python, IDL (Corba and Microsoft flavors), Fortran, VHDL, PHP, C#.
- FTP Download "Doxygen".
- Doxygen 1.6.3 ist the latest edition for Win98SE.
- “Doxygen has built-in support to generate inheritance diagrams for C++ classes. Doxygen can use the “dot” tool from graphviz to generate more advanced diagrams and graphs”.
- EN.Wikipedia "Doxygen", DE.Wikipedia "Doxygen".

code.(foosel), Ina Häußge and Philippe Neumann - "doxypy", GitHub "0xCAFEBABE/doxypy" - “An input filter for Doxygen”.
- Doxygen settings:
  - “FILTER_SOURCE_FILES = YES”.
  - Expert / Input / INPUT_FILTER = 'python /usr/local/bin/doxypy.py'”.
GitHub "Feneric/doxypypy" - A fork and successor of “doxypy”.
- Doxygen settings:
  - “Expert / Input / FILTER_PATTERNS = *.py=py_filter”.
- Batch file in “C:\Python27\Scripts\py_filter.bat”:
  - “python -m doxypypy.doxypypy -a -c %1”.

Doxygen "Helper tools and scripts".
- GitHub.io "JsUnit" - "Internal Developer's Guide" - “My script will call the Perl script js2doxy.pl to generate pseudo C++. Then it calls Doxygen to generate the first version of the HTML documentation. At last text processing is done with sed to generate the JsUnit color style in the headers” .
- Archive.org "XieWenjie's blog. Around emacs, linux, etc.: 'use doxygen to document javascript'" ( -2013-03-13 ).
Dimitar Trendafilov of “Coherent Labs”.
- GitHub Gist "dimitarcl/Doxyfile" - “Documenting JavaScript with Doxygen”.
- Coherent Labs "Documenting JavaScript with Doxygen".

Current:
- @use JSDoc.
- The current Github "jsdoc3 / jsdoc" for Node.js → JSDoc V.3.
- Missing block tags, in comparison to “Doxygen”:
  - Doxygen ”@date”.
  - Doxygen ”@brief” → JsDoc ”@summary”.
Legacy:
- The legacy Google Code "jsdoc-toolkit. A documentation generator for JavaScript".
- The legacy Google Code "jsdoc. JSDoc is an automatic documentation generator for JavaScript" → JSDoc V.2.
- ~~SourceForge "JSDoc"~~, ~~SourceForge "JSDoc"~~.
EN.Wikipedia "JSDoc".

The free Open Source “NDoc Code Documentation Generator for .NET” ( Sourceforge "NDoc", Sourceforge "NDoc" ).

Natural Docs.
Natural Docs "Language Support" - “C/C++, Java, PHP, Python, PL/SQL, Visual Basic, Pascal/Delphi, Ada, JavaScript, Ruby, Tcl, ColdFusion, Assembly, Fortran (free-format only), R, Makefiles, Plain Text”.

phpDocumentator - “A tool with which it is possible to generate documentation from your PHP source code”.

Frans Slothouber "Robo", GitHub "ROBODoc", SourceForge "ROBODoc", SourceForge "ROBODoc" - “A documentation tool. It extracts the documentation from your source code and formats it in HTML, RTF, TeX, XML DocBook (PDF), or ASCII. Works with C, C++, Fortran, Perl, Scripts, Assembler, Tcl, Basic, and any language that supports remarks”, “Works with C, C++, Fortran, Perl, shell scripts, Assembler, DCL, DB/C, Tcl/Tk, Forth, Lisp, COBOL, Occam, Basic, HTML, Clarion, and any other language that supports remarks”.

Text files formatted in “ReST”, “ReStructured Text”, format.
- Sourceforge "Docutils: Documentation Utilities. Written in Python, for General- and Special-Purpose Use", Sourceforge "Docutils: Documentation Utilities" - “Docutils is an open-source text processing system for processing plaintext documentation into useful formats, such as HTML or LaTeX”.
Dependency graph.
- EN.Wikipedia "Dependency graph".
- Sourceforge "Doxygen" has built-in support to generate inheritance diagrams for C++ classes. Doxygen can use the “dot” tool from graphviz to generate more advanced diagrams and graphs”.
  - Example: Atmel Corporation "Calendar service unit tests on Xplain", "unit_tests.c File Reference".
- Software tools to create dependency graphs: See Virtual Reality & Graphics, “Free Graph Visualization and Manipulation Software”.

Association of Software Professionals "Portable Application Description (PAD)" - “PAD is the Portable Application Description, and it helps authors provide product descriptions and specifications to online sources in a standard way, using a standard data format that will allow webmasters and program librarians to automate program listings”.