Re: Question reagarding documentation

2014-03-13 Thread Lukasz Lenart
Hi, I have started moving snippets from code to Wiki. This is also needed to properly export wiki as html - current version of Confluence doesn't recognise snippet macro and treats it as a old wiki content, but thus can be changed in the future. So if you work on some Java code in Struts, please

Re: Question reagarding documentation

2014-02-20 Thread Dave Newton
+1(00) On Thu, Feb 20, 2014 at 3:04 AM, Lukasz Lenart wrote: > Yes, I think wiki/html is the proper format here - all other projects > doing the same and I don't see complains about that. Maybe I'm wrong > but I opt to move snippets with examples and explanations to wiki. > > The main problem wi

Re: Question reagarding documentation

2014-02-20 Thread Lukasz Lenart
Yes, I think wiki/html is the proper format here - all other projects doing the same and I don't see complains about that. Maybe I'm wrong but I opt to move snippets with examples and explanations to wiki. The main problem with out current documentation is scale - it's very large, there should sim

Re: Question reagarding documentation

2014-02-11 Thread Dave Newton
So we could pull them in via snippets. I'd rather see examples be either in tests, separate files, or just normal documentation (e.g., wiki). Dave On Tue, Feb 11, 2014 at 10:08 AM, Andreas Opitz wrote: > What was the reason to put the snippets into the Javadocs? > Am 11.02.2014 15:25 schrieb

Re: Question reagarding documentation

2014-02-11 Thread Lukasz Lenart
2014-02-11 16:08 GMT+01:00 Andreas Opitz : > What was the reason to put the snippets into the Javadocs? Version control and one point of reference Regards -- Ɓukasz + 48 606 323 122 http://www.lenart.org.pl/ - To unsubscribe,

Re: Question reagarding documentation

2014-02-11 Thread Andreas Opitz
What was the reason to put the snippets into the Javadocs? Am 11.02.2014 15:25 schrieb "Dave Newton" : > Just for the record (again), I'm against putting documentation in the > Javadocs. > > It makes the Javadocs illegible when being read as Javadocs and bloats them > well beyond the point of usef

Re: Question reagarding documentation

2014-02-11 Thread Dave Newton
Just for the record (again), I'm against putting documentation in the Javadocs. It makes the Javadocs illegible when being read as Javadocs and bloats them well beyond the point of usefulness. On Tue, Feb 11, 2014 at 8:56 AM, Andreas Opitz wrote: > Hi Struts Community, > > last year I was on a