JavadocMethod checks for @see annotations

Stephen Gaffigan <[email protected]> Tue, 22 Nov 2011 13:19:05 -0500
Newsgroups gmane.comp.java.audit.checkstyle.user
Message-ID <[email protected]> 
This is a multi-part message in MIME format.
--===============3071512538347644808==
Content-Type: multipart/alternative;
	boundary="------------080502020604090504070409"

This is a multi-part message in MIME format.
--------------080502020604090504070409
Content-Type: text/plain; charset=ISO-8859-1; format=flowed
Content-Transfer-Encoding: 7bit

Hello,

I've recently begun using checkstyle to check Javadoc compliance in my 
Java projects.  I use it through ant as well as through the eclipse-cs 
plugin.  I've found it very easy to install and get configured, and it's 
a great replacement for the previous tool I used for this purpose (Sun 
DocCheck).

I'm looking for a JavadocMethod check that checks for @see annotations 
in get and set access methods.  For example, I'd want errors/warnings if 
either of the @see annotations were missing in the below code.  Is this 
possible with checkstyle?  Does it require that I write a custom check?

/**
   * Get access method for foo.
   * @return Foo
   * @see #setFoo(Foo)
   */
public Foo getFoo() {
    return this.foo;
}

/**
   * Set access method for foo.
   * @param foo Value to set
   * @see #getFoo()
   */
public void setFoo(Foo foo) {
    this.foo = foo;
}

Thanks for the great tool.

Steve


--------------080502020604090504070409
Content-Type: text/html; charset=ISO-8859-1
Content-Transfer-Encoding: 7bit

<html>
  <head>

    <meta http-equiv="content-type" content="text/html; charset=ISO-8859-1">
  </head>
  <body bgcolor="#FFFFFF" text="#000000">
    Hello,<br>
    <br>
    I've recently begun using checkstyle to check Javadoc compliance in
    my Java projects.&nbsp; I use it through ant as well as through the
    eclipse-cs plugin.&nbsp; I've found it very easy to install and get
    configured, and it's a great replacement for the previous tool I
    used for this purpose (Sun DocCheck).<br>
    <br>
    I'm looking for a JavadocMethod check that checks for @see
    annotations in get and set access methods.&nbsp; For example, I'd want
    errors/warnings if either of the @see annotations were missing in
    the below code.&nbsp; Is this possible with checkstyle?&nbsp; Does it require
    that I write a custom check?<br>
    <br>
    <font face="Courier New, Courier, monospace">/**<br>
      &nbsp; * Get access method for foo.<br>
      &nbsp; * @return Foo<br>
      &nbsp; * @see #setFoo(Foo)<br>
      &nbsp; */<br>
      public Foo getFoo() {<br>
      &nbsp;&nbsp; return this.foo;<br>
      }<br>
      <br>
      /**<br>
      &nbsp; * Set access method for foo.<br>
      &nbsp; * @param foo Value to set<br>
      &nbsp; * @see #getFoo()<br>
      &nbsp; */<br>
      public void setFoo(Foo foo) {<br>
      &nbsp;&nbsp; this.foo = foo;<br>
      }<br>
    </font><br>
    Thanks for the great tool.<br>
    <br>
    Steve<br>
    <br>
  </body>
</html>

--------------080502020604090504070409--


--===============3071512538347644808==
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: inline

------------------------------------------------------------------------------
All the data continuously generated in your IT infrastructure 
contains a definitive record of customers, application performance, 
security threats, fraudulent activity, and more. Splunk takes this 
data and makes sense of it. IT sense. And common sense.
http://p.sf.net/sfu/splunk-novd2d
--===============3071512538347644808==
Content-Type: text/plain; charset="us-ascii"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
Content-Disposition: inline

_______________________________________________
Checkstyle-user mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/checkstyle-user

--===============3071512538347644808==--