Mercurial Mercurial > tips / file revision
summary | shortlog | changelog | graph | tags | bookmarks | branches | files | changeset | file | latest | revisions | annotate | diff | comparison | raw | help
Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
source-docgen.rst
author Oleksandr Gavenko <gavenkoa@gmail.com>
Mon, 22 Feb 2016 12:46:36 +0200
changeset 1905 fba288d59662
child 1912 8b81a8f0f692
permissions -rw-r--r--
Include only local subsections into TOC. This prevent duplication of TOC when build single page HTML document. Also this make unnecessary CSS hack to hide document title as top level section.

.. -*- coding: utf-8; -*-
.. include:: HEADER.rst

=========================
 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.
tips