I agree that the way maven is organized helps some...I really like the way
the apache Tomcat products are split up by revision on the main page...it
really makes navigating the page easy.
As for the javadoc I think it is a good idea...I know I've had to dig
through the code to figure out how things were working when it wasn't
explained clearly in the documentation. At least with javadoc developers may
be able to find what the are looking for faster. The ActiveMQ project
suffers from javadoc laziness as well...so maybe we could help promote this
philosophy there :)
bsnyder wrote:
>
> On 10/5/07, Guillaume Nodet <[EMAIL PROTECTED]> wrote:
>> I was wondering if we should create a separate wiki space for
>> ServiceMix 4.0 documentation.
>
> That's a good idea, in fact, we will need to completely restructure
> the wiki into two sections; 3.x and 4.x similar to the way that the
> Maven team did it when Maven 2 overtook Maven 1.
>
>> Also I need to take a look at how the camel book works: it generates a
>> pdf from the wiki, so maybe we could do the same...
>
> I'm sure you know this already Guillaume, but for the sake of others
> here's how this works. There's a page on the ActiveMQ wiki named Book
> In One Page that contains the contents of the book. This page is then
> exported to PDF using Prince XML and the Boom CSS. This is a very
> powerful combination that produces a very nice PDF for download.
>
> And speaking of docs, another goal of ServiceMix 4.0 is to provide
> great Javadocs and comments in the code to explain everything as much
> as possible. So if you are reading through the code and see something
> that is not Javadoc'd or commented appropriately, please stop and fix
> that broken window (i.e., fix the problems when they are small, before
> they get big).
>
> Bruce
> --
> perl -e 'print
> unpack("u30","D0G)[EMAIL PROTECTED]&5R\"F)R=6-E+G-N>61E<D\!G;6%I;\"YC;VT*"
> );'
>
> Apache ActiveMQ - http://activemq.org/
> Apache ServiceMix - http://servicemix.org/
> Apache Geronimo - http://geronimo.apache.org/
> Castor - http://castor.org/
>
>
--
View this message in context:
http://www.nabble.com/ServiceMix-4.0-documentation-tf4573543s12049.html#a13065370
Sent from the ServiceMix - Dev mailing list archive at Nabble.com.
