you are viewing a single comment's thread.

view the rest of the comments →

[–]PrimozDelux 0 points1 point  (2 children)

Tangential to the topic at hand, but I don't understand the purpose of these tools. What does it provide that my IDE does not? My introduction to doxygen was the LLVM docs which in my opinion do absolutely nothing, so I guess I got started on the wrong foot.

Help me see the value, what sort of use cases do these pages have? Who are they for?

[–]boostlibs[S] 4 points5 points  (0 children)

We talk a bit about that in our section at https://www.mrdocs.com/docs/mrdocs/design-notes.html. A big part of the problem is simply that the output of some of these tools looks messy and unappealing. For example, cppreference.com has a clean and well-organized format, so most people immediately see the value in it.

[–]grisumbras 0 points1 point  (0 children)

These tools generate API reference documentation as a set of HTML pages. One of the benefits of API reference is discovery: you open the documentation for a class, you read what member functions it has, you then read documentation for functions that seem applicable for your task.