[hdoc]

Hello HN, we've posted here several times but today we're announcing that hdoc is becoming open source. Our goal is to make hdoc available to a broader set of developers. On top of that, we're hosting the deveopment of open source projects for free at hdoc.io.

Feel free to ask questions, we'll be answering as needed.

[billconan]

does this tool support preprocessor?

in my project, I use the catch2 framework,

the unit tests look like

TEST_CASE("....") {

}

this macro will be treated as invalid syntax by many c++ parsers, including doxygen's I think.

I notice that hdoc is based on clang. I tried using clang to dump syntax tree of the above code snippet, the result was incomprehensible, because the macro has been expanded by the preprocessor.

[hdoc]

hdoc uses Clang to parse your C++ code, so anything that Clang compiles should be fine. It's one of the benefits of using a production-quality parser instead of a homemade one like some other tools do.

[billconan]

I'm interested in trying hdoc.

I actually tried using clang -ast-dump to dump syntax tree of the above code snippet, the result was incomprehensible, because the macro has been expanded by the preprocessor.

[hdoc]

The preprocessor will still be run prior to hdoc parsing your code, and the result should be valid assuming the your code is well-formed. C++ AST dumps are generally incomprehensible ;)

Please do try hdoc. The source is now available and there are precompiled binaries available on hdoc.io. It takes about 2 minutes to go from downloading hdoc to seeing your documentation on a website if you use the latter route.