What is the documentation created by doxygen called

245 Views Asked by At

As I understood it "javadoc" is the name of the tool that generates html-documentation which also goes by the name javadoc. Atleast that is how I've been using the words..

But what is the generated output of the tool doxygen called? Doxygen-doc? doxy-doc? or maybe something else?

(Question in c++ context, if it matters)

2

There are 2 best solutions below

0
On

Separate the tools from the output format.

Javadoc is a markup system. I think it is incorrect to call its html output (or any other output) "javadoc". The same way as you would not call a web page styled in Word "Word".

Similarly, Doxygen is also a markup system. It does not have its own documentation output type. Its 'types' are the output types it supports, that is: HTML, Latex, Man pages, RTF and more. See the full list.

You mention C++. Doxygen supports "C, Objective-C, C#, PHP, Java, Python, IDL (Corba, Microsoft, and UNO/OpenOffice flavors), Fortran, VHDL, Tcl, and to some extent D. See Overview.

0
On

Short answer: "Design Documentation"

It's not a file format, it's a type of document that can be in any format. Usually html if you used Doxygen to create it.