Don't really understand. In a bit of a rush if I reread it maybe it would
sink in:

If you mean to prevent the code from updating the developer guide then
great. The developer guide should contain links to the javadoc where
appropriate which of course does need to stay in sync with the code. No
content should be removed from the source files. Although adding links to
the dev guide would certainly help.

BTW if you search "sturts2 javadoc" the first page is:
http://struts.apache.org/javadoc.html ->
http://struts.apache.org/development/2.x/struts2-core/apidocs/index.html
 (Broken, kind of annoying)




On Thu, Apr 18, 2013 at 2:00 AM, Christian Grobmeier <grobme...@gmail.com>wrote:

> +1
>
>
> On Thu, Apr 18, 2013 at 9:40 AM, Lukasz Lenart <lukaszlen...@apache.org>
> wrote:
> > Hi,
> >
> > Right now we have a small mismatch where the docs are kept. They are
> > partially in Confluence and partially in a source code of a class.
> > Take look on that page [1] and you will find a nice looking sections
> > messed up with a bit ugly inlined code. The problem is that to correct
> > that I have to know the source code, I mean which class is included by
> > a snippet to render given section. So basically I must hit Edit on the
> > page, check the name of the class, go to IDE, change class, commit,
> > etc.... very long path to improve just a typo :\
> >
> > My idea is to move all the descriptions into wiki and left just a
> > brief description of a class with a link to the docs.
> >
> > [1] http://struts.apache.org/development/2.x/docs/actionmapper.html
> >
> >
> > Regards
> > --
> > Ɓukasz
> > + 48 606 323 122 http://www.lenart.org.pl/
> >
> > ---------------------------------------------------------------------
> > To unsubscribe, e-mail: dev-unsubscr...@struts.apache.org
> > For additional commands, e-mail: dev-h...@struts.apache.org
> >
>
>
>
> --
> http://www.grobmeier.de
> https://www.timeandbill.de
>
> ---------------------------------------------------------------------
> To unsubscribe, e-mail: dev-unsubscr...@struts.apache.org
> For additional commands, e-mail: dev-h...@struts.apache.org
>
>

Reply via email to