empty author table in html report ?

classic Classic list List threaded Threaded
3 messages Options
Reply | Threaded
Open this post in threaded view
|

empty author table in html report ?

dmichel

Hi all,

While checkstyle apparently runs smoothly (i.e. no warning/error message), the html report doesn't give any info per authors as it should, i.e. the authors table is empty.

The thing is I don't know how checkstyle identifies an author. Does it look at the javadoc tag @author ? at the class level or at the method level ? or what ?

I used the default sun_checks.xml provided with the distribution and the ant task I used is below:

<taskdef resource="checkstyletask.properties" classpath="${checkstyle.dir}/checkstyle-all-5.0.jar"/>
<target name="checkstyle" description="Generates a report of code convention violations.">
   
<mkdir dir="${checkstyle.dir}"/>
   
<checkstyle config="${checkstyle.dir}/sun_checks.xml" failureProperty="checkstyle.failure" failOnViolation="false">
       
<formatter type="xml" tofile="${checkstyle.dir}/checkstyle_report.xml"/>
       
<fileset dir="${src.dir}" includes="**/*.java"/>
   
</checkstyle>
 
<xslt in="${checkstyle.dir}/checkstyle_report.xml" out="${checkstyle.dir}/checkstyle_report.html" style="${checkstyle}/checkstyle-author.xsl"/>
</target>

Many thanks for your help

David



---
Dr. David Michel
Address: 8 Viking Drive, Didcot, OX11 9RD, Oxfordshire
Mobile: 0789 670 98 01 - Home: 0123 581 46 93


------------------------------------------------------------------------------
SOLARIS 10 is the OS for Data Centers - provides features such as DTrace,
Predictive Self Healing and Award Winning ZFS. Get Solaris 10 NOW
http://p.sf.net/sfu/solaris-dev2dev
_______________________________________________
Checkstyle-user mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/checkstyle-user
Reply | Threaded
Open this post in threaded view
|

Re: empty author table in html report ?

Oliver Burn
The "${checkstyle}/checkstyle-author.xsl" stylesheet is doing the detection of the authors. I would recommend looking in there as my knowledge runs out there (it was a contributed XSLT).

On Wed, Feb 17, 2010 at 22:50, David Michel <[hidden email]> wrote:

Hi all,

While checkstyle apparently runs smoothly (i.e. no warning/error message), the html report doesn't give any info per authors as it should, i.e. the authors table is empty.

The thing is I don't know how checkstyle identifies an author. Does it look at the javadoc tag @author ? at the class level or at the method level ? or what ?

I used the default sun_checks.xml provided with the distribution and the ant task I used is below:

<taskdef resource="checkstyletask.properties" classpath="${checkstyle.dir}/checkstyle-all-5.0.jar"/>
<target name="checkstyle" description="Generates a report of code convention violations.">
   
<mkdir dir="${checkstyle.dir}"/>
   
<checkstyle config="${checkstyle.dir}/sun_checks.xml" failureProperty="checkstyle.failure" failOnViolation="false">
       
<formatter type="xml" tofile="${checkstyle.dir}/checkstyle_report.xml"/>
       
<fileset dir="${src.dir}" includes="**/*.java"/>
   
</checkstyle>
 
<xslt in="${checkstyle.dir}/checkstyle_report.xml" out="${checkstyle.dir}/checkstyle_report.html" style="${checkstyle}/checkstyle-author.xsl"/>
</target>

Many thanks for your help

David



---
Dr. David Michel
Address: 8 Viking Drive, Didcot, OX11 9RD, Oxfordshire
Mobile: 0789 670 98 01 - Home: 0123 581 46 93


------------------------------------------------------------------------------
SOLARIS 10 is the OS for Data Centers - provides features such as DTrace,
Predictive Self Healing and Award Winning ZFS. Get Solaris 10 NOW
http://p.sf.net/sfu/solaris-dev2dev
_______________________________________________
Checkstyle-user mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/checkstyle-user



------------------------------------------------------------------------------
Download Intel&reg; Parallel Studio Eval
Try the new software tools for yourself. Speed compiling, find bugs
proactively, and fine-tune applications for parallel performance.
See why Intel Parallel Studio got high marks during beta.
http://p.sf.net/sfu/intel-sw-dev
_______________________________________________
Checkstyle-user mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/checkstyle-user
Reply | Threaded
Open this post in threaded view
|

Re: empty author table in html report ?

dmichel
Hi Oliver,

Thanks, I saw that checkstyle-author.xsl was dealing with this, but I have to admit my knowledge of xslt transformations is limited...

In the head of that xsl file, there is a little note saying that the WriteTag check should be used in combination, so I added that to the xml file I'm using, i.e.:

        <module name="WriteTag">
            <property name="tag" value="@author"/>
            <property name="tagFormat" value="\S"/>
            <property name="severity" value="ignore"/>
        </module>

However, this doesn't seem to change anything and the output author table is still empty.

I will email the developer who contributed to this directly. He might be able to help out.

Many thanks

David


On 18 February 2010 05:24, Oliver Burn <[hidden email]> wrote:
The "${checkstyle}/checkstyle-author.xsl" stylesheet is doing the detection of the authors. I would recommend looking in there as my knowledge runs out there (it was a contributed XSLT).

On Wed, Feb 17, 2010 at 22:50, David Michel <[hidden email]> wrote:

Hi all,

While checkstyle apparently runs smoothly (i.e. no warning/error message), the html report doesn't give any info per authors as it should, i.e. the authors table is empty.

The thing is I don't know how checkstyle identifies an author. Does it look at the javadoc tag @author ? at the class level or at the method level ? or what ?

I used the default sun_checks.xml provided with the distribution and the ant task I used is below:

<taskdef resource="checkstyletask.properties" classpath="${checkstyle.dir}/checkstyle-all-5.0.jar"/>
<target name="checkstyle" description="Generates a report of code convention violations.">
   
<mkdir dir="${checkstyle.dir}"/>
   
<checkstyle config="${checkstyle.dir}/sun_checks.xml" failureProperty="checkstyle.failure" failOnViolation="false">
       
<formatter type="xml" tofile="${checkstyle.dir}/checkstyle_report.xml"/>
       
<fileset dir="${src.dir}" includes="**/*.java"/>
   
</checkstyle>
 
<xslt in="${checkstyle.dir}/checkstyle_report.xml" out="${checkstyle.dir}/checkstyle_report.html" style="${checkstyle}/checkstyle-author.xsl"/>
</target>

Many thanks for your help

David



---
Dr. David Michel
Address: 8 Viking Drive, Didcot, OX11 9RD, Oxfordshire
Mobile: 0789 670 98 01 - Home: 0123 581 46 93


------------------------------------------------------------------------------
SOLARIS 10 is the OS for Data Centers - provides features such as DTrace,
Predictive Self Healing and Award Winning ZFS. Get Solaris 10 NOW
http://p.sf.net/sfu/solaris-dev2dev
_______________________________________________
Checkstyle-user mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/checkstyle-user



------------------------------------------------------------------------------
Download Intel&reg; Parallel Studio Eval
Try the new software tools for yourself. Speed compiling, find bugs
proactively, and fine-tune applications for parallel performance.
See why Intel Parallel Studio got high marks during beta.
http://p.sf.net/sfu/intel-sw-dev
_______________________________________________
Checkstyle-user mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/checkstyle-user



------------------------------------------------------------------------------
Download Intel&reg; Parallel Studio Eval
Try the new software tools for yourself. Speed compiling, find bugs
proactively, and fine-tune applications for parallel performance.
See why Intel Parallel Studio got high marks during beta.
http://p.sf.net/sfu/intel-sw-dev
_______________________________________________
Checkstyle-user mailing list
[hidden email]
https://lists.sourceforge.net/lists/listinfo/checkstyle-user