Convenient way of creating javadoc? [message #154572] |
Wed, 31 May 2006 13:54 |
Eclipse User |
|
|
|
Originally posted by: martin.gerner.nospam.com
I have a project for which I need to create quite a lot of javadoc.
Netbeans has a tool for doing this conveniently - Is there any for
netbeans? Some plugin, perhaps? I've searched around, but not been able to
find anything.
--
Martin Gerner
|
|
|
Re: Convenient way of creating javadoc? [message #154580 is a reply to message #154572] |
Wed, 31 May 2006 14:01 |
Eclipse User |
|
|
|
Originally posted by: hendrik_maryns.despammed.com
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1
Martin Gerner schreef:
> I have a project for which I need to create quite a lot of javadoc.
> Netbeans has a tool for doing this conveniently - Is there any for
> netbeans? Some plugin, perhaps? I've searched around, but not been able to
> find anything.
You mean Project->Generate Javadoc? You will have to fill in some
fields first...
H.
- --
Hendrik Maryns
==================
http://aouw.org
Ask smart questions, get good answers:
http://www.catb.org/~esr/faqs/smart-questions.html
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.2 (GNU/Linux)
iD8DBQFEfaHDe+7xMGD3itQRAmUiAJ95Dj6xK9J82hhbF2GnlpoFXjlv9ACe I2QO
TP01vlCGSAnfulcyM2SofSE=
=NQrv
-----END PGP SIGNATURE-----
|
|
|
Re: Convenient way of creating javadoc? [message #154670 is a reply to message #154580] |
Wed, 31 May 2006 20:48 |
Eclipse User |
|
|
|
Originally posted by: martin.gerner.nospam.com
Hendrik Maryns <hendrik_maryns@despammed.com> wrote in
news:e5k7k3$pc0$1@utils.eclipse.org:
>> I have a project for which I need to create quite a lot of javadoc.
>> Netbeans has a tool for doing this conveniently - Is there any for
>> netbeans? Some plugin, perhaps? I've searched around, but not been
>> able to find anything.
>
> You mean Project->Generate Javadoc? You will have to fill in some
> fields first...
Ah, no, that's not what I meant. Is there some tool that can help me to
write the javadoc comments in my source code? I understand that it was easy
to misinterpret my original post.
--
Martin Gerner
|
|
|
Re: Convenient way of creating javadoc? [message #154709 is a reply to message #154572] |
Thu, 01 June 2006 01:08 |
Eclipse User |
|
|
|
Originally posted by: wharley.bea.com
"Martin Gerner" <martin.gerner@nospam.com> wrote in message
news:Xns97D4A1D058289martindotgerneratnos@206.191.52.34...
>I have a project for which I need to create quite a lot of javadoc.
> Netbeans has a tool for doing this conveniently - Is there any for
> netbeans? Some plugin, perhaps? I've searched around, but not been able to
> find anything.
Eclipse will automatically produce comments for new files, classes, and
methods if you let it. The template for the comments is configurable (look
in Java Code Style -> Code Templates) and supports javadoc.
You can also add these comments for existing objects. Use Source ->
Generate Element Comment.
|
|
|
|
Re: Convenient way of creating javadoc? [message #154758 is a reply to message #154709] |
Thu, 01 June 2006 09:21 |
Eclipse User |
|
|
|
Originally posted by: hendrik_maryns.despammed.com
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1
Walter Harley schreef:
> "Martin Gerner" <martin.gerner@nospam.com> wrote in message
> news:Xns97D4A1D058289martindotgerneratnos@206.191.52.34...
>> I have a project for which I need to create quite a lot of javadoc.
>> Netbeans has a tool for doing this conveniently - Is there any for
>> netbeans? Some plugin, perhaps? I've searched around, but not been able to
>> find anything.
>
> Eclipse will automatically produce comments for new files, classes, and
> methods if you let it. The template for the comments is configurable (look
> in Java Code Style -> Code Templates) and supports javadoc.
>
> You can also add these comments for existing objects. Use Source ->
> Generate Element Comment.
Easier: Shift+Alt+J. You can also set a preference for the Java
compiler to produce a warning when Javadoc is missing, and then this is
available as a Quick Fix too.
H.
- --
Hendrik Maryns
==================
http://aouw.org
Ask smart questions, get good answers:
http://www.catb.org/~esr/faqs/smart-questions.html
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.2 (GNU/Linux)
iD8DBQFEfrGIe+7xMGD3itQRAm/jAJ9vmA9tVCG2e1k5jnL3M7mUKFx52ACf cb0V
Pc8KXIbKgzZZ1aNfUpdfO3A=
=/Zmx
-----END PGP SIGNATURE-----
|
|
|
Re: Convenient way of creating javadoc? [message #154766 is a reply to message #154670] |
Thu, 01 June 2006 09:23 |
Eclipse User |
|
|
|
Originally posted by: hendrik_maryns.despammed.com
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1
Martin Gerner schreef:
> Hendrik Maryns <hendrik_maryns@despammed.com> wrote in
> news:e5k7k3$pc0$1@utils.eclipse.org:
>
>>> I have a project for which I need to create quite a lot of javadoc.
>>> Netbeans has a tool for doing this conveniently - Is there any for
>>> netbeans? Some plugin, perhaps? I've searched around, but not been
>>> able to find anything.
>> You mean Project->Generate Javadoc? You will have to fill in some
>> fields first...
>
> Ah, no, that's not what I meant. Is there some tool that can help me to
> write the javadoc comments in my source code? I understand that it was easy
> to misinterpret my original post.
Of course it are only templates which are generated, for example,
hitting Alt+Ctrl+J on the following line:
void visit(final Formula form) throws VisitorException;
generates this:
/**
*
*
* @param form
* @throws VisitorException
*/
The meaningful parts of course still have to be filled out.
H.
- --
Hendrik Maryns
==================
http://aouw.org
Ask smart questions, get good answers:
http://www.catb.org/~esr/faqs/smart-questions.html
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.2 (GNU/Linux)
iD8DBQFEfrITe+7xMGD3itQRAhNVAJ0URjV5gqdMzgMub7eiIzh2+XUmswCf UoZx
/Us3HWvpvzY95h/b5jUXYlI=
=WGdu
-----END PGP SIGNATURE-----
|
|
|
Re: Convenient way of creating javadoc? [message #154782 is a reply to message #154758] |
Thu, 01 June 2006 11:39 |
Eclipse User |
|
|
|
Originally posted by: martin.gerner.nospam.com
Hendrik Maryns <hendrik_maryns@despammed.com> wrote in news:e5mbi8$21t$1
@utils.eclipse.org:
> Easier: Shift+Alt+J. You can also set a preference for the Java
> compiler to produce a warning when Javadoc is missing, and then this is
> available as a Quick Fix too.
Ok, it was something like this I was looking for, but since I'm new to
Eclipse I didn't know about it. Thanks :)
--
Martin Gerner
|
|
|
|
Re: Convenient way of creating javadoc? [message #154809 is a reply to message #154790] |
Thu, 01 June 2006 13:12 |
Eclipse User |
|
|
|
Originally posted by: hendrik_maryns.despammed.com
-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1
Martin Gerner schreef:
> "Walter Harley" <wharley@bea.com> wrote in
> news:e5lem8$auf$1@utils.eclipse.org:
>
>> You can also add these comments for existing objects. Use Source ->
>> Generate Element Comment.
>>
>
> Hm, I don't have any such option under source.. I have Eclipse SDK 3.1.2.
> What might be wrong?
It is called Add comment.
H.
- --
Hendrik Maryns
==================
http://aouw.org
Ask smart questions, get good answers:
http://www.catb.org/~esr/faqs/smart-questions.html
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.2 (GNU/Linux)
iD8DBQFEfufKe+7xMGD3itQRAifWAJ9jHuMjUP8trbTlexAJi73kW4+l4gCf cj0k
0rTWu28N2Ga+dezaFv1ZtP4=
=6CtC
-----END PGP SIGNATURE-----
|
|
|
|
Powered by
FUDForum. Page generated in 0.08782 seconds