atom feed142 messages in org.apache.cocoon.devRe: Public/Private classification (wa...
FromSent OnAttachments
73 earlier messages
Pier FumagalliOct 4, 2005 2:31 am 
Bertrand DelacretazOct 4, 2005 2:36 am 
Daniel FagerstromOct 4, 2005 3:01 am 
Andrew SavoryOct 4, 2005 3:13 am 
UpayaviraOct 4, 2005 3:17 am 
Bertrand DelacretazOct 4, 2005 3:29 am 
Steven NoelsOct 4, 2005 3:39 am 
Torsten CurdtOct 4, 2005 3:47 am 
hepaboluOct 4, 2005 4:00 am 
Joerg HeinickeOct 4, 2005 4:39 am 
Sylvain WallezOct 4, 2005 4:57 am 
Daniel FagerstromOct 4, 2005 5:48 am 
Arje CahnOct 4, 2005 5:55 am 
Stefano MazzocchiOct 4, 2005 9:08 am 
Sylvain WallezOct 4, 2005 9:24 am 
Carsten ZiegelerOct 4, 2005 12:43 pm 
Steven NoelsOct 5, 2005 3:57 am 
Carsten ZiegelerOct 10, 2005 5:02 am 
Joerg HeinickeOct 11, 2005 2:03 pm 
Vadim GritsenkoOct 11, 2005 8:01 pm 
Stefano MazzocchiOct 11, 2005 8:16 pm 
Vadim GritsenkoOct 11, 2005 8:35 pm 
Bertrand DelacretazOct 11, 2005 11:20 pm 
Max PfingsthornOct 12, 2005 12:31 am 
Torsten CurdtOct 12, 2005 12:32 am 
Bertrand DelacretazOct 12, 2005 12:58 am 
Sylvain WallezOct 12, 2005 1:34 am 
Carsten ZiegelerOct 12, 2005 2:21 am 
Daniel FagerstromOct 12, 2005 4:52 am 
Stefano MazzocchiOct 12, 2005 8:58 am 
Stefano MazzocchiOct 12, 2005 9:01 am 
UpayaviraOct 12, 2005 9:20 am 
Vadim GritsenkoOct 12, 2005 9:38 am 
Stefano MazzocchiOct 12, 2005 9:47 am 
Niclas HedhmanOct 12, 2005 10:04 am 
UpayaviraOct 12, 2005 11:57 am 
hepaboluOct 12, 2005 12:43 pm 
Stefano MazzocchiOct 12, 2005 2:09 pm 
Stefano MazzocchiOct 12, 2005 2:18 pm 
Stefano MazzocchiOct 12, 2005 2:20 pm 
Sylvain WallezOct 12, 2005 2:35 pm 
Vadim GritsenkoOct 12, 2005 2:47 pm 
Daniel FagerstromOct 13, 2005 2:41 am 
Reinhard PoetzOct 13, 2005 3:25 am 
Vadim GritsenkoOct 13, 2005 8:07 am 
Ralph GoersOct 13, 2005 9:14 am 
Vadim GritsenkoOct 13, 2005 9:22 am 
Ralph GoersOct 13, 2005 9:44 am 
Daniel FagerstromOct 13, 2005 9:56 am 
Stefano MazzocchiOct 13, 2005 10:01 am 
Stefano MazzocchiOct 13, 2005 10:05 am 
Daniel FagerstromOct 13, 2005 1:59 pm 
Joerg HeinickeOct 13, 2005 2:03 pm 
Joerg HeinickeOct 13, 2005 2:05 pm 
Stefano MazzocchiOct 13, 2005 3:25 pm 
Reinhard PoetzOct 13, 2005 10:57 pm 
Daniel FagerstromOct 14, 2005 2:05 am 
Vadim GritsenkoOct 14, 2005 6:01 am 
Vadim GritsenkoOct 14, 2005 6:06 am 
Stefano MazzocchiOct 14, 2005 11:34 am 
Vadim GritsenkoOct 14, 2005 11:45 am 
Reinhard PoetzOct 15, 2005 1:38 am 
Joerg HeinickeOct 15, 2005 1:40 am 
Joerg HeinickeOct 15, 2005 1:45 am 
Stefano MazzocchiOct 15, 2005 8:53 am 
Stefano MazzocchiOct 15, 2005 9:08 am 
Peter HunsbergerOct 21, 2005 10:12 pm 
Stefano MazzocchiOct 23, 2005 10:39 am 
Peter HunsbergerOct 24, 2005 8:05 am 
Subject:Re: Public/Private classification (was Re: javadocs navigation)
From:Stefano Mazzocchi (stef@apache.org)
Date:Oct 13, 2005 10:01:04 am
List:org.apache.cocoon.dev

Daniel Fagerstrom wrote:

Upayavira wrote:

So, I have created a wiki page:

http://wiki.apache.org/cocoon/PublicAPIClasses

Please go there and mark classes public/private as necessary. As it says at the top of that page, if you disagree with someone, change it to "dispute" or D for short. Then it becomes an opportunity for some healthy argument!

Wow! that's a lot of classes. While I aplaud the initiative, 673 classes are huge amount to classify. I would suggest that we start discussing principles first a bit.

Here's my principle: since I write all my business logic in flow, I want to know which ones are the things that I can expect to call from flow.

Documenting FOM is one thing, but then we have a bunch of other things (like SourceUtil and excalibur resolver etc) that I use all the time.

So, my rationale is not to document XMLPipe (since I'll never use it or implement it in flow) but to have an idea, from the cocoon user point of view, of where are the hooks.

So, there are 4 levels:

1) FOM (the javascript objects available to flow) 2) the static java utils + avalon components 3) the cocoon interfaces 4) the cocoon classes

we document #1 (badly, if you ask me, it's a pain to find) and the rest is one huge bundled javadoc and our class classification by package does *NOT* induce itself to the classification above (maybe #3 and #4, given that we use impl to indicate what implements an interface, and we use .components even if not all of those are meant to be used in flow)

If we want to appeal to the users, we need to tell them loud and clear what are the hooks they can use. Otherwise, it feels like flying without a net.

Some people here want to move to javaflow to have eclipse do the work for them, I think we have to do something anyway.