source-docgen.rst
author Oleksandr Gavenko <gavenkoa@gmail.com>
Wed, 19 Dec 2018 14:07:30 +0200
changeset 2307 08aa10b9c7ff
parent 2228 837f1337c59b
permissions -rw-r--r--
Add timestamp to Vagrant log.

.. -*- coding: utf-8; -*-

=========================
 Source code documenting
=========================
.. contents::
   :local:

About
=====

* http://en.wikipedia.org/wiki/Comparison_of_documentation_generators

Doxygen
=======

Doxygen is a documentation generator for C++, C, Java, Objective-C, Python,
IDL (CORBA and Microsoft flavors), Fortran, VHDL, PHP, C#.

http://www.doxygen.org
  Home page.
http://en.wikipedia.org/wiki/Doxygen
  Wikipedia page.

DOC++
=====

DOC++ is 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. The documentation is extracted directly from
the C/C++/IDL header/source files or Java class files.

http://docpp.sourceforge.net/
  Home page.

ROBODoc
=======

ROBODoc is 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.

http://sourceforge.net/projects/robodoc
  Home page.
http://en.wikipedia.org/wiki/ROBODoc
  Wikipedia page.