FAQ

Do I need to install Graphviz if I do not use diagrams?

No, if you do not use the inheritance-diagram plugin then you don't have to install Graphviz.

Why is Pharox written in Javascript and not C or C++?

When dealing with online websites it makes it a natural fit. It’s popular, simple, and aligns perfectly with the KISS principle.

Does Pharox parse C++ like a compiler?

No. It is regex- and content-driven and focuses on comments (Doxygen-formatted blocks) more than on full syntax trees.

What comment style should I use?

Doxygen-style tags (\brief, \param, \return, ... ) are the expected convention so Pharox can lift text into the generated docs.

So why not just use Doxygen?

Doxygen is more like a reference dumper. It produces noise by default which requires a lot of configuration and curation to eliminate. Styling, SEO and Layout are just a few more complains. Developers often use a hybrid approach by combining different tools like MkDocs, Sphinx with Doxygen to achieve some degree of customization. Developers have enough struggles, generating a clean modern documentation shouldn't be one of them.

Will there be other languages supported like Java or Python?

They are on the roadmap. Because the model emphasizes inline/structured comments rather than deep language semantics, adding more languages is plausible over time.

How do I write or enable a plugin?

Start with the Plugins page.

How do I report bugs or request features?

Email to tommy.draeger@systemi.co.jp. For bugs, what you expected, what you got, and how to reproduce is enough

Can you add a backlink to my documentation?

If you use Pharox for your project’s documentation and want to be listed, reach out to tommy.draeger@systemi.co.jp. Backlinks are welcome for projects that actually use the tool.