On April 23, 2021 9:00:14 AM GMT+01:00, "Libor Polčák" <polcak@fit.vutbr.cz> wrote:
Hi all, here's a rundown of our fights with Doxygen so far.
So, our ideal situation would be to use Doxygen for the whole site -- Libor has been using it effectively for the non-technical part of the docs (and a blog!) which was a revelation to us. So we set out to see how Doxygen can be twisted to use different layouts and allow deeper customization.
However, after a lot of experimentation and doc reading, we found that Doxygen only supports adding custom headers and footers -- the HTML templates themselves are not exposed to the user and cannot be overridden.
So our way out seems to be to make a custom Doxygen build with our templates. It sounds overkill, but we couldn't find a way that's less complex. There are a few libraries that can extract JS comments, but the Doxygen syntax is not rendered and we'd have to write a parser for those.
Maybe you know of a saner approach? We can discuss this tomorrow in our call.
Hello Ricardo,
it seems the https://jsdoc.app/ has a very similar syntax to Doxygen. I do not have any experience with JSDoc so I do not know how much compatible the doc strings are. But it seems to me that it makes sense to try JSDoc and have a look if it is more suitable for the project.
Regards,
Libor