search

pringscreem / FileCombiner

C++ program to combine multiple other C++ source files into one file by appending them to a single .cpp file
0 stars 0 forks source link

Recommend a documentation format/program #14

Closed pringscreem closed 1 month ago

pringscreem commented 1 month ago

Research options for better documentation (Doxygen is one option). Provide at least two options, preferably five.

A future issue is implementing documentation of everything.

pringscreem commented 1 month ago

List: https://en.wikipedia.org/wiki/Comparison_of_documentation_generators

Doxygen: https://www.doxygen.nl/ "Doxygen has built-in support to generate inheritance diagrams for C++ classes." https://en.wikipedia.org/wiki/Doxygen

Spinx https://www.sphinx-doc.org/en/master/ Linux is switching to Sphinx. https://en.wikipedia.org/wiki/Sphinx_(documentation_generator)

HeaderDoc https://developer.apple.com/library/archive/documentation/DeveloperTools/Conceptual/HeaderDoc/intro/intro.html Apple's documentation tool. Designed to work with XCode (Apple's IDE). https://en.wikipedia.org/wiki/HeaderDoc

Imagix4D https://www.imagix.com/ Also used for analyzing code. Also does static analysis (looks for bugs before runtime) and provides numbers (metrics) about quality. https://en.wikipedia.org/wiki/Imagix_4D

RDoc https://ruby.github.io/rdoc/ Ruby documentation tool. Does some automatic documenting of classes.

Document! X https://www.innovasys.com/help/dx/welcome.html Paid option. Probably nice, especially with Visual Studio.

pringscreem commented 1 month ago

Doxygen is the winner. It also seems to be the standard. This yielded a lot of bookmarks to read for learning later.