in reply to Re: Documenting non-public OO components
in thread Documenting non-public OO components
You can use a leading underscore to indicate that a variable or function should not be used outside the package that defined it.
The Pod::Coverage problem is solvable with minimal effort, as both you and xdg have pointed out (thanks). However, there is still the need to document these methods while indicating clearly that they are not available to users.
There seems to be a range of opinion on as to the best solution. The ones that I like best for this project at least are the ones closest to javadoc, but I can appreciate the merits of the document-by-test and the bury-private-docs-deeply schools as well.
|
|---|
| Replies are listed 'Best First'. | |
|---|---|
|
Re^3: Documenting non-public OO components
by petdance (Parson) on Sep 09, 2005 at 19:41 UTC |