cocoon-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Ralph Goers <>
Subject Re: Public/Private classification
Date Thu, 13 Oct 2005 16:44:39 GMT
Vadim Gritsenko wrote:

> Ralph Goers wrote:
>> Vadim Gritsenko wrote:
>>> Reinhard Poetz wrote:
>>>> --- Daniel Fagerstrom <> schrieb:
>>>>> IMO we need to find two set of interfaces/classes:
>>>>> the API of Cocoon, and the set of classes (components) that an
>>>>> application programmer need JavaDoc for.
>>> If it ain't public API you ain't need Javadoc for it, period.
>> Why would you say that?  Javadoc can help explain what private 
>> classes and methods do just as well as it does for public ones.
> It is said in the context; it is in the context of programming against 
> this Javadoc. Of course we will have full Javadoc - but it's not our 
> "Cocoon Public APIs Javadoc".
> Vadim

Well, I agree with that, but that doesn't seem to match the statement 
"If it ain't public API you ain't need Javadoc for it, period.".  The 
implication to me in that statement is that if it isn't a public API you 
shouldn't put javadoc in the code.


View raw message