cocoon-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Vadim Gritsenko <va...@reverycodes.com>
Subject Re: javadocs navigation
Date Wed, 12 Oct 2005 16:39:03 GMT
Upayavira wrote:
> Stefano Mazzocchi wrote:
> 
>> Sylvain Wallez wrote:
>>
>>> Or more simpler, and we already talked about this, what about tagging 
>>> the source files themselves to be able to produce javadocs of a 
>>> restricted set of classes, i.e. those that are considered public API 
>>> and that people can safely rely on.
>>
>> There you go! +1
> 
> So how do we decide what is internal, what is external? The discussion 
> is likely to be "fun".

Let's start small - let's mark as public, external classes only those where we 
have consensus, and leave "questionable" classes out, have a discussion on them 
later.


> We could have a wiki page containing all classes, and mark the ones on 
> that wiki page that we want to be public. Then a script could add the 
> necessary javadoc markup.

Wiki page, where each java class can be marked as one of:
   public / private / dispute / not-marked-yet.


> If that approach sounds okay, I'd happily volunteer to write the script 
> to add the markup, assuming it is a simple enough markup.

Sounds good

Vadim

Mime
View raw message