Re: Moving docs from the source

2013-04-23 Thread Lukasz Lenart
2013/4/22 Rene Gielen : > I'm not too sure that this is a net win in the end, though I see the > (big) itch you want to scratch. We introduced the Javadoc snippets to > remove duplication on documentation. I'm pretty sure that most users > really appreciate that our Javadocs contain really deep inf

Re: Moving docs from the source

2013-04-22 Thread Rene Gielen
I'm not too sure that this is a net win in the end, though I see the (big) itch you want to scratch. We introduced the Javadoc snippets to remove duplication on documentation. I'm pretty sure that most users really appreciate that our Javadocs contain really deep information including examples. Als

Re: Moving docs from the source

2013-04-18 Thread Ken McWilliams
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 con

Re: Moving docs from the source

2013-04-18 Thread Christian Grobmeier
+1 On Thu, Apr 18, 2013 at 9:40 AM, Lukasz Lenart 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 b

Re: Moving docs from the source

2013-04-18 Thread Umesh Awasthi
+1 On Thu, Apr 18, 2013 at 1:10 PM, Lukasz Lenart 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 b

Moving docs from the source

2013-04-18 Thread Lukasz Lenart
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 kno