So a few years ago I came across a statement that most of the Doxygen generated documentation out there is quite bad. "Bad" in the sense that defies the purpose of documentation and doesn't help in understanding the code. To an extent, I think this also applies to other automatic documentation generators.
The majority of Doxygen-ated stuff I have seen was okay; you could work with it. Of course there's always the really bad apple that leaves scars in your memory.
So far, I've not come across some documentation which made me go: "Oh, wow, this is written really well, I love it."
- What should a developer do in order to avoid auto-generating bad documentation that doesn't help future developers?
- And are there additional things that could be done that would make the auto-generated documentation good so it actually helps future developers?