Hacker Newsnew | past | comments | ask | show | jobs | submitlogin

> Extensive documentation with examples can be found inline in the source header files.

I don't see this as a proper way to do docs. At least give a first-time viewer a glimpse of what this might be useful for. I'm completely in the dark, myself.



Don't worry. They will abandon it in a few weeks because they rewrote a new one that works better.


Check the sides. As for header docs, they do seem extensive: https://github.com/facebook/fatal/blob/master/fatal/type/pre...


Agreed. However, it's still viable to go that route if you have a document-generating tool like doxygen that will pull all of this data out and make a (rather hideous, but usable) bunch of html documentation.

This is not an example of that.




Guidelines | FAQ | Lists | API | Security | Legal | Apply to YC | Contact

Search: