hdoc

4 ms·

1.
by hdoc 6y ago
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 th
2.
by hdoc 6y ago
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.
3.
by hdoc 6y ago
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 s
4.
Show HN: hdoc, the modern documentation tool for C++, is now open source(hdoc.io)
7 points by hdoc 6y ago|5 comments
5.
by hdoc 6y ago
We're looking at open sourcing hdoc in the future, and at least offering a free plan in the near term. We'd like to give back to the community too, it's part of the reason why we host our LLVM documentation freely. We're
6.
by hdoc 6y ago
I agree that bad documentation is often due to lack of effort. Many developers don't like writing documentation, which is unfortunate because bad documentation can drag down otherwise great projects. If I'm evaluating two librarie
7.
by hdoc 6y ago
LLVM/Clang are generally well-documented but there are places that don’t have great coverage. Unfortunately tools are only part of the solution. Our goal with hdoc is to make writing documentation easier and to make it easier to create
8.
by hdoc 6y ago
Yes, this is one of the many improvements we plan on adding soon. It was cut from the MVP because we wanted to ensure that it was 100% accurate. Complex code bases can be ambiguous and it would be a disservice if the user clicked on one of
9.
by hdoc 6y ago
When we originally implemented the Doxygen command support we looked at the most used commands in the code bases we profiled, and settled on about five, which we cut down to those three. Support for more commands is on the roadmap as we loo
10.
by hdoc 6y ago
C++ is falling behind in the quality of documentation output compared to what tools like rustdoc, ReadTheDocs, and godoc generate. Getting good output from existing C++ tools requires disproportionate effort that could be better spent elsew
11.
Show HN: A modern documentation tool for C++ and a replacement for Doxygen(hdoc.io)
31 points by hdoc 6y ago|12 comments
12.
by hdoc 6y ago
https://hdoc.io/ More or less a modern replacement of Doxygen. The goal is to make writing good documentation easy. To accomplish that we've incorporated Markdown pages alongside the documentation, a modern and lightwe
13.
by hdoc 6y ago
The hdoc alpha release is now available on Linux and we're looking for feedback from users. If you're interested in a better documentation tool for C++, please consider trying out the alpha. Thanks.
14.
Show HN: hdoc alpha release – a modern documentation tool for C++(hdoc.io)
3 points by hdoc 6y ago|1 comments
15.
Show HN: Hdoc – a modern documentation tool for C++(hdoc.io)
3 points by hdoc 6y ago|0 comments