I'm one of those developers that has the mindset that the code written should be self-explanatory and read like a book.HOWEVER, when developing library code for other people to use I try to put as much documentation in the header files as possible; which brings up the question: Is documenting methods that are non-Public even worth the time? They won't be using them directly, in fact, they can't. At the same time if I distribute the raw code (albeit, reluctantly) those non-Public methods will be visible and may need explaining.Just looking for some standards and practices that you all see or use in your travels.
Code documentation: Public vs. Non-Public?
c++;documentation
I would never consider omitting documentation for internals just because an end user won't be using them; code maintenance is more than enough reason to include documentation comments for all components, in fact especially for internals which tend to be the most complex (and oft-changing) part.That said, there may be a valid case to be made for keeping them restricted to the non-header source code (rather than publicly documented), in order to maintain the abstraction.This is all rather subjective, mind you.