Doxygen vs RDoc
Doxygen
doxygen.nlRDoc
ruby.github.ioSide by side
| Figure | Doxygen | RDoc |
|---|---|---|
| Price from | Free | Free |
| Free plan | Yes | Yes |
| Free trial | — | — |
| Open source | — | — |
| Windows | Yes | — |
| macOS | Yes | — |
| Linux | Yes | Yes |
| Self-hosted | — | Yes |
| Plans published | 1 | 1 |
| Spec score · Documentation Generators | 7.8 (#11) | 8.1 (#8) |
| License | Doxygen is licensed under the GNU General Public License and is provided without express or implied warranty. | RDoc is free software and may be redistributed under the terms in its license file. |
| Purpose | Doxygen is a documentation generator that creates documentation from source-code comments and parses classes, functions and variables. | RDoc produces HTML and command-line documentation for Ruby projects, with `rdoc` and `ri` tools to generate and display it. |
| Support | Users are directed to Stack Overflow and the doxygen users mailing list, while commercial feature or bug-fix support has limited capacity. | The project directs users to CONTRIBUTING.md for filing bug reports. |
Plans
In their own words
Doxygen
Doxygen is a free documentation generator that turns source-code comments into reference material, parsing items such as classes, functions and variables. It supports C/C++, Lex, Java, Python, VHDL, PHP IDL, C#, Fortran, Objective-C 2.0 and some D sources. Output can be generated as HTML, PDF through LaTeX, Word through RTF or structured XML for external tools. Graphviz’s dot tool can add include-dependency, collaboration, call, directory-structure and class-hierarchy diagrams. Doxywizard provides a graphical interface for editing settings and running the generator on Windows, Linux and macOS; Doxygen also works on many Unix flavors. It supports HTML Help, docsets, Qt-Help and Eclipse Help, with more than 100 configurable options. The tool runs without registration and does not collect personal or usage data. It is self-hosted and licensed under the GNU General Public License, without express or implied warranty. Help is listed through Stack Overflow and the doxygen users mailing list; commercial feature and bug-fix support has limited capacity.
RDoc
RDoc is free software for producing Ruby project documentation as HTML pages and command-line reference output. The `rdoc` command generates documentation, while `ri` displays it. It processes Ruby, C, and RBS source files, plus RDoc markup, Markdown, RD, and TomDoc documents. RBS declarations can describe classes, modules, methods, attributes, and constants, and can add comments or type signatures to matching Ruby source documentation. A local preview server watches source files and refreshes the browser after changes. It uses Ruby’s built-in TCPServer and needs no external gems, but provides neither HTTPS nor HTTP/2 and is intended only for local previews. RDoc reports documentation coverage with `rdoc -C`, or includes parameter names with `rdoc -C1`. Generation can be automated through Rake or the RDoc API. Aliki is the default theme; Darkfish is deprecated. Ruby 3.2.0 or newer is required for the current gem.