search

erez-o / docsforge

Modern C/C++ documentation generator for open source projects.
https://docsforge.com/
27 stars 1 forks source link

Allow displaying doxygen's html output. #43

Open erez-o opened 3 years ago

erez-o commented 3 years ago

For debugging purposes, seeing doxygen's html output can be quite useful . This is especially true when playing with doxygen's preprocessor commands.

Instead of requiring the users to install doxygen on their local pc, it's better to allow displaying its html in docsforge.

This debugging flag will be disabled by default, since it takes extra time for project docs to built.

biojppm commented 3 years ago

That is indeed a step forward.

But may I suggest an alternative approach, where instead of the Doxygen config file being generated by docsforge, we provide an existing Doxygen file? I think this would scale better. In my view it is not a problem to ask a user to try out doxygen in his computer.

In fact, going one step further, wouldn't it make sense to be able to generate the Docsforge output in a user's local PC?

erez-o commented 3 years ago

Thanks for the input,

Providing a doxygen file was my original idea, but it's problematic because it's often not a standalone file (used in conjunction with cmake commands), and only a handful of doxygen's cfg parameters affect docsforge. Most of docsforge's configuration are not related to doxygen, so you would need 2 configuration files (one for docsforge and one for doxygen).

Regarding your second suggestion, I was aiming for the opposite approach - docs created and deployed online in sync with your repo without any need for the developer to worry about installing on their pc, updating doxygen/docsforge on new releases, or deploying the docs to the web.

The reason for this enhancement was only for debgging purposes to help pinpoint if the problem originated from doxygen or docsforge.