Re: Check for @param sentence format

Allon Mureinik <[email protected]> Mon, 26 Aug 2013 03:56:06 -0400 (EDT)
Newsgroups gmane.comp.java.audit.checkstyle.user
Message-ID <[email protected]> 
--===============3341165894704746830==
Content-Type: multipart/alternative; 
	boundary="----=_Part_453196_325408348.1377503766032"

------=_Part_453196_325408348.1377503766032
Content-Type: text/plain; charset=utf-8
Content-Transfer-Encoding: 7bit

Hi Roman, Tony, 

DocCheck has been dead for several years now. 
The link to DocCheck results in a 404 error, and the only discussions about it in Oracle forums are about it's disappearance (at least, the only discussions I could find). 
e.g.: 
https://forums.oracle.com/thread/2358795 
https://forums.oracle.com/thread/1523108 

I did, however, find a fork of it in project.net - not sure how up to date it is, or whether it supports modern java language features: 
http://dev.project.net/trac/pnet-community/browser/trunk/tools/doccheck/lib/doccheck.jar?rev=6613 

-Allon 

----- Original Message -----

> From: "Roman Ivanov" <[email protected]>
> To: [email protected]
> Sent: Monday, August 26, 2013 4:04:05 AM
> Subject: Re: [Checkstyle-user] Check for @param sentence format

> Hello Tom,

> Please take a look at
> http://www.oracle.com/technetwork/java/javase/documentation/index-137868.html

> from that page:
> At Oracle, we have developed a tool for checking doc comments, called the
> Oracle Doc Check Doclet, or DocCheck . You run it on source code and it
> generates a report describing what style and tag errors the comments have,
> and recommends changes. We have tried to make its rules conform to the rules
> in this document.

> Thanks,
> Roman Ivanov.

> From: Roman Ivanov <[email protected]>
> Sent: Sunday, August 25, 2013 5:48PM
> To: [email protected]
> CC:
> Subject: Re: [Checkstyle-user] Check for @param sentence format

> > Hello Tony,
> 

> > There is no way in Checkstyle have access to JavaDoc content, all comments
> > are ignored.
> 
> > To examine to what tokens Checkstyle have access please launch:
> 
> > java -classpath checkstyle-5.6-all.jar
> > com.puppycrawl.tools.checkstyle.gui.Main
> 

> > Workaround (if you need that feature badly):
> 
> > you can try to use RegularExpressionCheck -
> > http://checkstyle.sourceforge.net/config_regexp.html
> 
> > But do it with caution and proper testing, that could not guaranty you 100%
> > coverage of all cases but might help to find most of cases.
> 

> > Thanks,
> 
> > Roman Ivanov.
> 

> > From: Tony HEDOUX <[email protected]>
> 
> > Sent: Tuesday, August 20, 2013 7:44AM
> 
> > To: [email protected]
> > <[email protected]>
> 
> > CC:
> 
> > Subject: [Checkstyle-user] Check for @param sentence format
> 

> > > Hi,
> > 
> 

> > > I'm looking for a way to check the format of java @param comments.
> > 
> 

> > > For example, I want to ensure these comments begin with an uppercase and
> > > do
> > > not finished with a point.
> > 
> 

> > > I can achieve this easily on Class parameter with the WriteTag checker.
> > > But
> > > I
> > > can't find a way to do it works for a method comments.
> > 
> 

> > > Any clue about this?
> > 
> 

> > > Thx for help,
> > 
> 

> > > Tony
> > 
> 

> > > ------------------------------------------------------------------------------
> > 
> 
> > > Introducing Performance Central, a new site from SourceForge and
> > 
> 
> > > AppDynamics. Performance Central is your source for news, insights,
> > 
> 
> > > analysis and resources for efficient Application Performance Management.
> > 
> 
> > > Visit us today!
> > > http://pubads.g.doubleclick.net/gampad/clk?id=48897511&iu=/4140/ostg.clktrk
> > 
> 

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

> > ------------------------------------------------------------------------------
> 
> > Introducing Performance Central, a new site from SourceForge and
> 
> > AppDynamics. Performance Central is your source for news, insights,
> 
> > analysis and resources for efficient Application Performance Management.
> 
> > Visit us today!
> > http://pubads.g.doubleclick.net/gampad/clk?id=48897511&iu=/4140/ostg.clktrk
> 

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

> ------------------------------------------------------------------------------
> Introducing Performance Central, a new site from SourceForge and
> AppDynamics. Performance Central is your source for news, insights,
> analysis and resources for efficient Application Performance Management.
> Visit us today!
> http://pubads.g.doubleclick.net/gampad/clk?id=48897511&iu=/4140/ostg.clktrk
> _______________________________________________
> Checkstyle-user mailing list
> [email protected]
> https://lists.sourceforge.net/lists/listinfo/checkstyle-user

------=_Part_453196_325408348.1377503766032
Content-Type: text/html; charset=utf-8
Content-Transfer-Encoding: quoted-printable

<html><body><div style=3D"font-family: times new roman, new york, times, se=
rif; font-size: 12pt; color: #000000"><div>Hi Roman, Tony,</div><div><br></=
div><div>DocCheck has been dead for several years now.</div><div>The link t=
o DocCheck results in a 404 error, and the only discussions about it in Ora=
cle forums are about it's disappearance (at least, the only discussions I c=
ould find).</div><div>e.g.:</div><div><a href=3D"https://forums.oracle.com/=
thread/2358795" data-mce-href=3D"https://forums.oracle.com/thread/2358795">=
https://forums.oracle.com/thread/2358795</a></div><div><a href=3D"https://f=
orums.oracle.com/thread/1523108" data-mce-href=3D"https://forums.oracle.com=
/thread/1523108">https://forums.oracle.com/thread/1523108</a></div><div><br=
></div><div>I did, however, find a fork of it in project.net - not sure how=
 up to date it is, or whether it supports modern java language features:</d=
iv><div><a href=3D"http://dev.project.net/trac/pnet-community/browser/trunk=
/tools/doccheck/lib/doccheck.jar?rev=3D6613" data-mce-href=3D"http://dev.pr=
oject.net/trac/pnet-community/browser/trunk/tools/doccheck/lib/doccheck.jar=
?rev=3D6613">http://dev.project.net/trac/pnet-community/browser/trunk/tools=
/doccheck/lib/doccheck.jar?rev=3D6613</a></div><div><br></div><div><br></di=
v><div>-Allon</div><div><br></div><hr id=3D"zwchr"><blockquote style=3D"bor=
der-left:2px solid #1010FF;margin-left:5px;padding-left:5px;color:#000;font=
-weight:normal;font-style:normal;text-decoration:none;font-family:Helvetica=
,Arial,sans-serif;font-size:12pt;"><b>From: </b>"Roman Ivanov" &lt;ivanov-j=
[email protected]&gt;<br><b>To: </b>[email protected]<br><b>Sen=
t: </b>Monday, August 26, 2013 4:04:05 AM<br><b>Subject: </b>Re: [Checkstyl=
e-user] Check for @param sentence format<br><div><br></div>
 =20
   =20
 =20
 =20
    <div id=3D"smartTemplate4-quoteHeader">
      <div style=3D"font-family:Verdana; font-size:14px">
        <span data-mce-style=3D"font-size: 14px; font-family: Verdana;" sty=
le=3D"font-size: 14px; font-family: Verdana;" face=3D"Verdana">Hello Tom,
          <br>
          <br>
          Please take a look at&nbsp; <br>
<a class=3D"moz-txt-link-freetext" href=3D"http://www.oracle.com/technetwor=
k/java/javase/documentation/index-137868.html" target=3D"_blank">http://www=
.oracle.com/technetwork/java/javase/documentation/index-137868.html</a><br>
          <br>
        </span>from that page:<br>
        <span data-mce-style=3D"font-size: 14px; font-family: Verdana;" sty=
le=3D"font-size: 14px; font-family: Verdana;" face=3D"Verdana">At Oracle, w=
e have
          developed a tool for checking doc comments, called the Oracle
          Doc Check Doclet, or <a href=3D"http://www.oracle.com/technetwork=
/java/javase/documentation/ssLINK/141437" target=3D"_blank">DocCheck</a>.
          You run it on source code and it generates a report describing
          what style and tag errors the comments have, and recommends
          changes. We have tried to make its rules conform to the rules
          in this document.<br>
          <br>
          Thanks,<br>
          Roman Ivanov.</span> <br>
        <hr>
        <div><b>From:</b> Roman Ivanov <a class=3D"moz-txt-link-rfc2396E" h=
ref=3D"mailto:[email protected]" target=3D"_blank">&lt;[email protected]&gt=
;</a></div>
        <div><b>Sent:</b> Sunday, August 25, 2013 5:48PM</div>
        <div><b>To:</b> <a class=3D"moz-txt-link-abbreviated" href=3D"mailt=
o:[email protected]" target=3D"_blank">checkstyle-user@=
lists.sourceforge.net</a></div>
        <div><b>CC:</b> </div>
        <div><b>Subject:</b> Re: [Checkstyle-user] Check for @param
          sentence format</div>
      </div>
      <br>
    </div>
    <blockquote cite=3D"mid:[email protected]">
     =20
      <div id=3D"smartTemplate4-quoteHeader">
        <div style=3D"font-family:Verdana; font-size:14px">Hello Tony, <br>
          <div id=3D"smartTemplate4-template"><span data-mce-style=3D"font-=
size: 14px; font-family: Verdana;" style=3D"font-size: 14px; font-family: V=
erdana;" face=3D"Verdana"> <br>
              There is no way in Checkstyle have access to JavaDoc
              content, all comments are ignored.<br>
              To examine to what tokens Checkstyle have access please
              launch:<br>
              java -classpath checkstyle-5.6-all.jar
              com.puppycrawl.tools.checkstyle.gui.Main<br>
              <br>
              Workaround (if you need that feature badly):<br>
              you can try to use RegularExpressionCheck - <a class=3D"moz-t=
xt-link-freetext" href=3D"http://checkstyle.sourceforge.net/config_regexp.h=
tml" target=3D"_blank">http://checkstyle.sourceforge.net/config_regexp.html=
</a><br>
              But do it with caution and proper testing, that could not
              guaranty you 100% coverage of all cases but might help to
              find most of cases.<br>
              <br>
              Thanks,<br>
              Roman Ivanov.</span> <br>
          </div>
          <hr>
          <div><b>From:</b> Tony HEDOUX <a class=3D"moz-txt-link-rfc2396E" =
href=3D"mailto:[email protected]" target=3D"_blank">&lt;[email protected]=
om&gt;</a></div>
          <div><b>Sent:</b> Tuesday, August 20, 2013 7:44AM</div>
          <div><b>To:</b> <a class=3D"moz-txt-link-abbreviated" href=3D"mai=
lto:[email protected]" target=3D"_blank">checkstyle-use=
[email protected]</a>
            <a class=3D"moz-txt-link-rfc2396E" href=3D"mailto:checkstyle-us=
[email protected]" target=3D"_blank">&lt;[email protected]=
eforge.net&gt;</a></div>
          <div><b>CC:</b> </div>
          <div><b>Subject:</b> [Checkstyle-user] Check for @param
            sentence format</div>
        </div>
        <br>
      </div>
      <blockquote cite=3D"mid:[email protected]">
        <style><!--
.hmmessage P
{
margin:0px;
padding:0px
}
body.hmmessage
{
font-size: 12pt;
font-family:Calibri
}
--></style>
        <div dir=3D"ltr">Hi,
          <div><br>
          </div>
          <div>I'm looking for a way to check the format of java @param
            comments.</div>
          <div><br>
          </div>
          <div>For example, I want to ensure these comments begin with
            an uppercase and do not finished with a point.</div>
          <div><br>
          </div>
          <div>I can achieve this easily on Class parameter with the
            WriteTag checker. But I can't find a way to do it works for
            a method comments.</div>
          <div><br>
          </div>
          <div>Any clue about this?</div>
          <div><br>
          </div>
          <div>Thx for help,</div>
          <div><br>
          </div>
          <div>Tony</div>
        </div>
        <br>
        <fieldset class=3D"mimeAttachmentHeader"></fieldset>
        <br>
        <pre>--------------------------------------------------------------=
----------------
Introducing Performance Central, a new site from SourceForge and=20
AppDynamics. Performance Central is your source for news, insights,=20
analysis and resources for efficient Application Performance Management.=20
Visit us today!
<a class=3D"moz-txt-link-freetext" href=3D"http://pubads.g.doubleclick.net/=
gampad/clk?id=3D48897511&amp;iu=3D/4140/ostg.clktrk" target=3D"_blank">http=
://pubads.g.doubleclick.net/gampad/clk?id=3D48897511&amp;iu=3D/4140/ostg.cl=
ktrk</a></pre>
        <br>
        <fieldset class=3D"mimeAttachmentHeader"></fieldset>
        <br>
        <pre>_______________________________________________
Checkstyle-user mailing list
<a class=3D"moz-txt-link-abbreviated" href=3D"mailto:Checkstyle-user@lists.=
sourceforge.net" target=3D"_blank">[email protected]</a=
>
<a class=3D"moz-txt-link-freetext" href=3D"https://lists.sourceforge.net/li=
sts/listinfo/checkstyle-user" target=3D"_blank">https://lists.sourceforge.n=
et/lists/listinfo/checkstyle-user</a>
</pre>
      </blockquote>
      <br>
      <br>
      <br>
      <fieldset class=3D"mimeAttachmentHeader"></fieldset>
      <br>
      <pre>----------------------------------------------------------------=
--------------
Introducing Performance Central, a new site from SourceForge and=20
AppDynamics. Performance Central is your source for news, insights,=20
analysis and resources for efficient Application Performance Management.=20
Visit us today!
<a class=3D"moz-txt-link-freetext" href=3D"http://pubads.g.doubleclick.net/=
gampad/clk?id=3D48897511&amp;iu=3D/4140/ostg.clktrk" target=3D"_blank">http=
://pubads.g.doubleclick.net/gampad/clk?id=3D48897511&amp;iu=3D/4140/ostg.cl=
ktrk</a></pre>
      <br>
      <fieldset class=3D"mimeAttachmentHeader"></fieldset>
      <br>
      <pre>_______________________________________________
Checkstyle-user mailing list
<a class=3D"moz-txt-link-abbreviated" href=3D"mailto:Checkstyle-user@lists.=
sourceforge.net" target=3D"_blank">[email protected]</a=
>
<a class=3D"moz-txt-link-freetext" href=3D"https://lists.sourceforge.net/li=
sts/listinfo/checkstyle-user" target=3D"_blank">https://lists.sourceforge.n=
et/lists/listinfo/checkstyle-user</a>
</pre>
    </blockquote>
    <br>
    <br>
    <div id=3D"smartTemplate4-template"><br>
    </div>
 =20


<br>-----------------------------------------------------------------------=
-------<br>Introducing Performance Central, a new site from SourceForge and=
 <br>AppDynamics. Performance Central is your source for news, insights, <b=
r>analysis and resources for efficient Application Performance Management. =
<br>Visit us today!<br>http://pubads.g.doubleclick.net/gampad/clk?id=3D4889=
7511&amp;iu=3D/4140/ostg.clktrk<br>________________________________________=
_______<br>Checkstyle-user mailing list<br>[email protected]=
e.net<br>https://lists.sourceforge.net/lists/listinfo/checkstyle-user<br></=
blockquote><div><br></div></div></body></html>
------=_Part_453196_325408348.1377503766032--


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

------------------------------------------------------------------------------
Introducing Performance Central, a new site from SourceForge and 
AppDynamics. Performance Central is your source for news, insights, 
analysis and resources for efficient Application Performance Management. 
Visit us today!
http://pubads.g.doubleclick.net/gampad/clk?id=48897511&iu=/4140/ostg.clktrk
--===============3341165894704746830==
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

--===============3341165894704746830==--