ROBODoc – generate documentation from source code comments

ROBODoc is a source code documentation generator that extracts specially formatted comments and converts them into separate technical reference documents. It is designed to let programmers maintain documentation directly alongside the code it describes.

The software uses structured comment headers to identify documented elements and the information associated with them. These headers can describe functions, procedures, classes, variables and other components of a program. ROBODoc processes the headers and produces a consistent reference document without requiring developers to maintain an entirely separate set of descriptions.

Its approach is largely independent of the underlying programming language, making it useful for projects written in languages that support source comments. ROBODoc is an older documentation system, but its straightforward model remains suitable for projects that already use its structured documentation conventions.

This is free and open source software.

Key Features

• Extracts structured documentation headers embedded within source code comments.
• Supports documentation for functions, methods, classes, variables and other program elements.
• Works with C, C++, Java, Pascal, Fortran, assembly language, shell scripts and numerous other languages.
• Recognises different header types for organising documentation sections.
• Generates HTML documentation with automatically created cross-references.
• Supports RTF, LaTeX and XML DocBook output formats.
• Can include selected portions of source code within generated documentation.
• Provides navigation between related documentation headers.
• Uses a consistent documentation structure across programming languages.
• Supports documentation indices for navigating large collections of source files.

Website: github.com/gumpu/ROBODoc
Support:
Developer: Frans Slothouber, Jacco van Weert, Petteri Kettunen, Bernd Koesling, and many others
License: GNU General Public License v3.0

ROBODoc is written in C. Learn C with our recommended free books and free tutorials.

Related Software

Read our verdict in the software roundup.

LinuxLinks helps you discover the best free and open source software for Linux. Explore our extensive collection of recommended applications, including alternatives to popular proprietary software. We also publish software reviews, Linux tutorials, hardware reviews, free programming books and articles covering the wider open source community. Browse our Linux resources to discover more. Know a useful free and open source Linux application we haven't covered? Suggest a program for inclusion. Has your software been featured on LinuxLinks? Display one of our Featured on LinuxLinks badges on your website or GitHub README.