You are viewing a plain text version of this content. The canonical link for it is here.
Posted to dev@tamaya.apache.org by "Oliver B. Fischer" <o....@swe-blog.net> on 2015/03/07 10:31:46 UTC
Your opinion: Asciidoctor for JavaDoc
Dear all,
what do you think about using Asciidoctor for our JavaDoc? I think it
offers better markup possibilities then pure JavaDoc.
WDYT?
Oliver
--
N Oliver B. Fischer
A Schönhauser Allee 64, 10437 Berlin, Deutschland/Germany
P +49 30 44793251
M +49 178 7903538
E o.b.fischer@swe-blog.net
S oliver.b.fischer
J oliver.b.fischer@jabber.org
X http://xing.to/obf
Re: Your opinion: Asciidoctor for JavaDoc
Posted by Werner Keil <we...@gmail.com>.
-1 There's an official API doc mechanism called JavaDoc, so why twist or
abuse it?
Other documents like high level architecture overview, how-tos, etc. sure,
why not, but leave a sound description of the code IN the code.
Werner
On Sat, Mar 7, 2015 at 10:38 AM, Romain Manni-Bucau <rm...@gmail.com>
wrote:
> +-0 just need to be consistent without more cost even for migration
> Le 7 mars 2015 10:34, "Oliver B. Fischer" <o....@swe-blog.net> a
> écrit :
>
> > Dear all,
> >
> > what do you think about using Asciidoctor for our JavaDoc? I think it
> > offers better markup possibilities then pure JavaDoc.
> >
> > WDYT?
> >
> > Oliver
> >
> > --
> > N Oliver B. Fischer
> > A Schönhauser Allee 64, 10437 Berlin, Deutschland/Germany
> > P +49 30 44793251
> > M +49 178 7903538
> > E o.b.fischer@swe-blog.net
> > S oliver.b.fischer
> > J oliver.b.fischer@jabber.org
> > X http://xing.to/obf
> >
> >
>
Re: Your opinion: Asciidoctor for JavaDoc
Posted by "Oliver B. Fischer" <o....@swe-blog.net>.
Ok, so we will stick to JavaDoc... ;-(
Am 07.03.15 um 10:46 schrieb Anatole Tresch:
> -1 stop adding yet another tool, we have enough other topics than wasting
> our time rewriting javadocs and adapting the build. Additional complexity
> on tool chain, lacking ide support, incompatible with future jsr.
> I would prefer you would help writing/reviewing/finishing documentation in
> the docs module so we can think on a first release. That is at least what I
> do for the code I have written ;)
>
> Cheers
> Anatole
> Romain Manni-Bucau <rm...@gmail.com> schrieb am Sa., 7. März 2015 um
> 10:38:
>
>> +-0 just need to be consistent without more cost even for migration
>> Le 7 mars 2015 10:34, "Oliver B. Fischer" <o....@swe-blog.net> a
>> écrit :
>>
--
N Oliver B. Fischer
A Schönhauser Allee 64, 10437 Berlin, Deutschland/Germany
P +49 30 44793251
M +49 178 7903538
E o.b.fischer@swe-blog.net
S oliver.b.fischer
J oliver.b.fischer@jabber.org
X http://xing.to/obf
Re: Your opinion: Asciidoctor for JavaDoc
Posted by Anatole Tresch <at...@gmail.com>.
-1 stop adding yet another tool, we have enough other topics than wasting
our time rewriting javadocs and adapting the build. Additional complexity
on tool chain, lacking ide support, incompatible with future jsr.
I would prefer you would help writing/reviewing/finishing documentation in
the docs module so we can think on a first release. That is at least what I
do for the code I have written ;)
Cheers
Anatole
Romain Manni-Bucau <rm...@gmail.com> schrieb am Sa., 7. März 2015 um
10:38:
> +-0 just need to be consistent without more cost even for migration
> Le 7 mars 2015 10:34, "Oliver B. Fischer" <o....@swe-blog.net> a
> écrit :
>
> > Dear all,
> >
> > what do you think about using Asciidoctor for our JavaDoc? I think it
> > offers better markup possibilities then pure JavaDoc.
> >
> > WDYT?
> >
> > Oliver
> >
> > --
> > N Oliver B. Fischer
> > A Schönhauser Allee 64, 10437 Berlin, Deutschland/Germany
> > P +49 30 44793251
> > M +49 178 7903538
> > E o.b.fischer@swe-blog.net
> > S oliver.b.fischer
> > J oliver.b.fischer@jabber.org
> > X http://xing.to/obf
> >
> >
>
Re: Your opinion: Asciidoctor for JavaDoc
Posted by Romain Manni-Bucau <rm...@gmail.com>.
+-0 just need to be consistent without more cost even for migration
Le 7 mars 2015 10:34, "Oliver B. Fischer" <o....@swe-blog.net> a
écrit :
> Dear all,
>
> what do you think about using Asciidoctor for our JavaDoc? I think it
> offers better markup possibilities then pure JavaDoc.
>
> WDYT?
>
> Oliver
>
> --
> N Oliver B. Fischer
> A Schönhauser Allee 64, 10437 Berlin, Deutschland/Germany
> P +49 30 44793251
> M +49 178 7903538
> E o.b.fischer@swe-blog.net
> S oliver.b.fischer
> J oliver.b.fischer@jabber.org
> X http://xing.to/obf
>
>