JavadocWriter plugin feeback request

Hi everybody,

I'm the author of JavadocWriter plugin ( http://www.intellij.org/twiki/bin/view/Main/JavadocWriter ). For now i've implemented two basic features (accessor javadoc inspection, and delete javadoc action) and I would like to know if you could provide feedback about these, and more importantly if you have ideas of new features that you would like to see.

Currently, i'm thinking about adding another inspection checking that you correctly have added a '.' at the end of each first sentence of a javadoc element in order to have a description in the 'condensed' area in the generated javadoc.

What do you guys think ?

PS : by the way, I can't wait to have a dedicated JIRA space for plugin writers (to receive bugs fixes and feature requests)... That would really keep the plugin community alive and kicking !

Gilles Philippart

5 comments

Hello Gilles,

GP> Currently, i'm thinking about adding another inspection checking
GP> that you correctly have added a '.' at the end of each first
GP> sentence of a javadoc element in order to have a description in the
GP> 'condensed' area in the generated javadoc.

In fact, this check is already performed by the standard "JavaDoc Problems"
inspection in IDEA.

--
Dmitry Jemerov
Software Developer
JetBrains, Inc.
http://www.jetbrains.com
"Develop with pleasure!"


0

Hello Gilles,
In fact, this check is already performed by the
standard "JavaDoc Problems"
inspection in IDEA.

--
Dmitry Jemerov
Software Developer
JetBrains, Inc.
http://www.jetbrains.com
"Develop with pleasure!"



Hello Dmitry,

I have the Javadoc issues inspection activated, and it doesn't highlight this type of issue for me, i've checked all configuration panels, and could not find a setting to enable it.

PS : i'm using 5.02

Gilles

0

Hello Gilles,

GP> I have the Javadoc issues inspection activated, and it doesn't
GP> highlight this type of issue for me, i've checked all configuration
GP> panels, and could not find a setting to enable it.

There are two different inspections for JavaDoc in 5.0.2: one of them performs
editor highlighting, and another can be used only for running batch inspections
from "Analyze Code". I don't remember the exact name for the second one;
you can search for "javadoc" to find it.

These inspections have been merged in Demetra.

--
Dmitry Jemerov
Software Developer
JetBrains, Inc.
http://www.jetbrains.com
"Develop with pleasure!"


0

Hi Gilles

I do like your plugin (I seldom run offline inspections)

One suggestion: when generating getter- and setter-comments it would be a
good idea to generate as well the
@see getFoo and @see setFoo tag as suggested by the check-doclet of sun.

thanks for that plugin!
-claude


0

Hi Claude,

Glad that you like the plugin :)

Do you mean a @see getFoo on setter and @see setFoo on the getter javadoc ?

0

Please sign in to leave a comment.