Javadoc Quality Checker (Sun)

From Kb

Contact Article Author | Blog of Article Author | FirstPartners.net Home | LinkedIn profile of Author

Sun Javadoc Quality Check tool allows you to automatically score the quality of your Javadoc and identify areas for improvement.

To use via command line

1. Download the Javadoc Quality Checker tool from the Sun Website
2. Extract the zip to a directory - e.g. to c:\software\javadoctool
3. Generate a list of packages to be checked with the Sun Package List Utility
   1. instructions are in index.html in the supplied zip
4. Run the Javadoc Quality Checking Tool.

To use via eclipse

1. Use the Wizard under file...export...javadoc
2. 1st line points to Javadoc.exe that comes with the JDK installed on your machine
3. Select the project you wish to export (checkbox)
4. Select 'Use Custom Doclet'
5. Doclet Name : com.sun.tools.doclets.doccheck.DocCheck
6. Doclet classpath :C:\software\doccheck1.2b2\doccheck.jar
   1. Or whereever you extracted doccheck
7. Press 'next'
8. VM Options : -J-Xmx180m

To use via Ant

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<project default="javadoc">
    <target name="javadoc">
        <javadoc access="public" classpath="../phase3/lib/displaytag-portlet-1.1.jar;../lib/standard.jar;../lib/xdoclet-oracle-module-1.2.3.jar;../" packagenames="ie.gov.fw.util.document.check,ie.gov.fw.exceptions.panel,ie.gov.fw.dao.interfaces.employee,ie.gov.fw.struts.forms.employeeportal.security,ie.gov.fw.dao.interfaces.campaign,ie.gov.fw.struts.actions.candidateportal.jobs,ie.gov.fw.model.score,ie.gov.fw.struts.navigation,ie.gov.fw.model.staff,ie.gov.fw.model.assessment.examhall,ie.gov.fw.business.panel,ie.gov.fw.business.request,ie.gov.fw.struts.forms.employeeportal.timetable,ie.gov.fw.ejb.session.facade.client,ie.gov.fw.struts.actions.candidateportal,ie.gov.fw.business.assessment,ie.gov.fw.struts.forms.employeeportal.board,ie.gov.fw.struts.forms.employeeportal.client,ie.gov.fw.business.assessment.timetable,ie.gov.fw.ejb.session.facade.scoreactivities,ie.gov.fw.ejb.session.facade.candidate,ie.gov.fw.struts.util.decorators.score,ie.gov.fw.dao.interfaces.assessment.publishing,ie.gov.fw.model.util,ie.gov.fw.business.assessment.timetable.allocation,ie.gov.fw.dao.ibatis.score,ie.gov.fw.ejb,ie.gov.fw.exceptions.assessment.allocation,ie.gov.fw.struts.actions.employeeportal.candidate.documents,ie.gov.fw.struts.util.decorators.client,ie.gov.fw.model.decentralisation,ie.gov.fw.model.application,ie.gov.fw.ejb.session.facade.assessment.allocation,ie.gov.fw.struts.actions.employeeportal.exam.allocation,ie.gov.fw.business.client,ie.gov.fw.struts.forms.clientportal.home,ie.gov.fw.model.user.impl,ie.gov.fw.jsp,ie.gov.fw.struts.actions.employeeportal.exam.event,ie.gov.fw.business.assessment.exam,ie.gov.fw.struts.actions.candidateportal.external,ie.gov.fw.dao.interfaces,ie.gov.fw.struts.actions.candidateportal.jobAlerts,ie.gov.fw.ejb.session.batch.facade.contact,ie.gov.fw.struts.forms.employeeportal.home,ie.gov.fw.util.security.access.data,ie.gov.fw.util.importing,ie.gov.fw.ejb.session.facade.decentralisation,ie.gov.fw.ejb.session.facade.request,ie.gov.fw.dao.interfaces.application,ie.gov.fw.struts.forms.candidateportal.home,ie.gov.fw.util.batch.print,ie.gov.fw.struts.actions.employeeportal.score,ie.gov.fw.exceptions.timetable,ie.gov.fw.struts.forms.employeeportal.timetable.allocation,ie.gov.fw.struts.actions.employeeportal.security,ie.gov.fw.dao.interfaces.assessment,ie.gov.fw.business,ie.gov.fw.struts.util.decorators.contact,ie.gov.fw.exceptions.application,ie.gov.fw.model.reporting,ie.gov.fw.business.util.documentmanagement.cms,ie.gov.fw.dao.interfaces.client,ie.gov.fw.exceptions.venue,ie.gov.fw.dao.interfaces.contact,ie.gov.fw.business.staff,ie.gov.fw.business.contact,ie.gov.fw.business.scoreactivities,ie.gov.fw.struts.util.decorators.venue,ie.gov.fw.model,ie.gov.fw.dao.ibatis.board,ie.gov.fw.ejb.session.batch.facade.communicator,ie.gov.fw.dao.ibatis.event,ie.gov.fw.dao.ibatis.request,ie.gov.fw.util.sql,ie.gov.fw.struts.forms.employeeportal.contact.messaging,ie.gov.fw.struts.actions,ie.gov.fw.dao.ibatis.contact,ie.gov.fw.dao.ibatis.candidate,ie.gov.fw.struts.forms.employeeportal.staff,ie.gov.fw.struts.util.decorators.timetable,ie.gov.fw.dao.ibatis.employee,ie.gov.fw.model.event,ie.gov.fw.dao.ibatis.application,ie.gov.fw.delegate.delegateimpl,ie.gov.fw.exceptions.contact,ie.gov.fw.struts.actions.employeeportal.reporting,ie.gov.fw.business.application.formvalidator,ie.gov.fw.struts.actions.employeeportal.client,ie.gov.fw.business.timer,ie.gov.fw.struts.util.decorators.event,ie.gov.fw.model.campaign,ie.gov.fw.struts.actions.employeeportal.marking,ie.gov.fw.struts.actions.candidateportal.security,ie.gov.fw.model.candidate.specialneeds,ie.gov.fw.struts.actions.employeeportal.candidate,ie.gov.fw.dao.interfaces.board,ie.gov.fw.struts.actions.employeeportal.test,ie.gov.fw.struts.actions.clientportal.request,ie.gov.fw.business.util.documentmanagement,ie.gov.fw.struts.actions.employeeportal.request,ie.gov.fw.struts.forms.employeeportal.candidate.documents,ie.gov.fw.util.export,ie.gov.fw.struts.actions.employeeportal.scoreactivities,ie.gov.fw.struts.actions.employeeportal.timetable,ie.gov.fw.util.template,ie.gov.fw.struts.forms.employeeportal.request,ie.gov.fw.struts.util.decorators.decentralisation,ie.gov.fw.util.communication.impl,ie.gov.fw.ejb.session.facade.contact,ie.gov.fw.dao.interfaces.candidate,ie.gov.fw.model.staff.details,ie.gov.fw.ejb.session.batch.jms,ie.gov.fw.struts.actions.employeeportal.contact,ie.gov.fw.struts.actions.util,ie.gov.fw.business.timer.job,ie.gov.fw.struts.util.decorators.application,ie.gov.fw.dao.interfaces.security.access,ie.gov.fw.struts.actions.employeeportal.timetable.candidate,ie.gov.fw.ejb.session.facade.assessment.exam,ie.gov.fw.business.campaign,ie.gov.fw.struts.plugins,ie.gov.fw.business.decentralisation,ie.gov.fw.exceptions.client,ie.gov.fw.jsp.taglib,ie.gov.fw.util,ie.gov.fw.dao.ibatis.assessment,ie.gov.fw.dao.interfaces.test,ie.gov.fw.struts.forms.employeeportal.marking,ie.gov.fw.struts.actions.employeeportal.board,ie.gov.fw.struts.forms.candidateportal.currentJobSearch,ie.gov.fw.struts.util.decorators.campaign,ie.gov.fw.util.security.access.functional,ie.gov.fw.ejb.session.facade.application,ie.gov.fw.model.candidate.searches,ie.gov.fw.exceptions.candidate,ie.gov.fw.struts.util.decorators.candidate,ie.gov.fw.dao.ibatis.assessment.candidate,ie.gov.fw.struts.actions.employeeportal.timetable.allocation,ie.gov.fw.struts.forms.employeeportal.score,ie.gov.fw.dao.interfaces.event,ie.gov.fw.struts.util.decorators.scoreactivities,ie.gov.fw.struts.actions.clientportal.campaign,ie.gov.fw.util.communication,ie.gov.fw.ejb.session.facade.score,ie.gov.fw.model.assessment.publishing,ie.gov.fw.dao.ibatis.util.type,ie.gov.fw.dao.interfaces.request,ie.gov.fw.dao.ibatis.marking,ie.gov.fw.struts.forms.candidateportal.bookings,ie.gov.fw.struts.forms.clientportal.security,ie.gov.fw.struts.actions.candidateportal.specialNeeds,ie.gov.fw.model.request,ie.gov.fw.business.reporting.impl,ie.gov.fw.dao.interfaces.score,ie.gov.fw.ejb.session.facade.test,ie.gov.fw.business.marking,ie.gov.fw.struts.actions.candidateportal.decentralisation,ie.gov.fw.ejb.session.facade.marking,ie.gov.fw.struts.actions.candidateportal.bookings,ie.gov.fw.struts.actions.employeeportal.exam.candidate,ie.gov.fw.struts.actions.employeeportal,ie.gov.fw.business.util.communication,ie.gov.fw.ejb.session.facade.staff,ie.gov.fw.exceptions.score,ie.gov.fw.business.application.formvalidator.impl,ie.gov.fw.struts.util.decorators.jobs,ie.gov.fw.business.candidate,ie.gov.fw.dao.ibatis.decentralisation,ie.gov.fw.exceptions.campaign,ie.gov.fw.struts.actions.employeeportal.contact.messaging,ie.gov.fw.util.document,ie.gov.fw.util.xml.mapping.interfaces,ie.gov.fw.struts.actions.employeeportal.candidate.messages,ie.gov.fw.dao.ibatis.security.access,ie.gov.fw.business.reporting,ie.gov.fw.dao.interfaces.decentralisation,ie.gov.fw.struts.actions.employeeportal.contact.tracking,ie.gov.fw.business.application,ie.gov.fw.struts.forms.employeeportal.campaign,ie.gov.fw.struts.actions.employeeportal.staff,ie.gov.fw.dao.ibatis.util,ie.gov.fw.struts.forms.employeeportal.contact,ie.gov.fw.struts.actions.clientportal.home,ie.gov.fw.dao.interfaces.util,ie.gov.fw.struts.actions.employeeportal.panel,ie.gov.fw.util.batch.contact,ie.gov.fw.struts.actions.employeeportal.assessment.util,ie.gov.fw.struts.actions.candidateportal.messages,ie.gov.fw.servlets.timer,ie.gov.fw.model.assessment.test,ie.gov.fw.model.assessment.allocation,ie.gov.fw.exceptions.board,ie.gov.fw.business.board,ie.gov.fw.util.batch.contact.impl,ie.gov.fw.model.audit,ie.gov.fw.struts.actions.employeeportal.exam.campaign,ie.gov.fw.model.assessment.candidate,ie.gov.fw.model.reporting.custom.desk.labels,ie.gov.fw.dao.ibatis.assessment.publishing,ie.gov.fw.dao.ibatis.client,ie.gov.fw.util.template.impl,ie.gov.fw.model.employee,ie.gov.fw.struts.forms.candidateportal.specialNeeds,ie.gov.fw.struts.forms.employeeportal.candidate,ie.gov.fw.struts.forms.employeeportal.exam,ie.gov.fw.struts.util.decorators.staff,ie.gov.fw.struts.actions.candidateportal.applications,ie.gov.fw.model.candidate.documents,ie.gov.fw.model.candidate,ie.gov.fw.struts.util,ie.gov.fw.model.board,ie.gov.fw.business.user,ie.gov.fw.dao.ibatis.test,ie.gov.fw.model.panel,ie.gov.fw.struts.actions.employeeportal.campaign,ie.gov.fw.struts.forms.employeeportal.test,ie.gov.fw.dao.interfaces.assessment.candidate,ie.gov.fw.model.assessment,ie.gov.fw.business.test,ie.gov.fw.ejb.session.batch.facade.batch.print,ie.gov.fw.struts.forms.employeeportal.campaign.sub,ie.gov.fw.dao.interfaces.assessment.examhall,ie.gov.fw.model.security.access,ie.gov.fw.exceptions.marking,ie.gov.fw.struts.forms.candidateportal.security,ie.gov.fw.ejb.session.facade.assessment.timetable,ie.gov.fw.business.util.batch.print,ie.gov.fw.util.process,ie.gov.fw.security.jaas.modules,ie.gov.fw.dao.ibatis.campaign,ie.gov.fw.struts.actions.employeeportal.venue,ie.gov.fw.dao.ibatis.panel,ie.gov.fw.struts.actions.clientportal.security,ie.gov.fw.struts.actions.clientportal,ie.gov.fw.servlets.formserver,ie.gov.fw.struts.forms.util,ie.gov.fw.ejb.session.facade.campaign,ie.gov.fw.struts.util.decorators.marking,ie.gov.fw.struts.forms.employeeportal.panel,ie.gov.fw.exceptions,ie.gov.fw.struts.forms.employeeportal.timetable.candidate,ie.gov.fw.struts.forms.employeeportal.venue,ie.gov.fw.security.jaas,ie.gov.fw.business.assessment.exam.allocation,ie.gov.fw.dao.interfaces.user,ie.gov.fw.exceptions.exam,ie.gov.fw.struts.forms.employeeportal.application,ie.gov.fw.util.mail.auditing,ie.gov.fw.model.reporting.custom,ie.gov.fw.struts.actions.candidateportal.home,ie.gov.fw.ejb.session.facade.framework,ie.gov.fw.model.client,ie.gov.fw.dao,ie.gov.fw.util.batch.print.impl,ie.gov.fw.model.user,ie.gov.fw.struts.util.decorators.exam,ie.gov.fw.struts.forms.clientportal.request,ie.gov.fw.util.xml.mapping,ie.gov.fw.struts.forms.candidateportal.jobAlerts,ie.gov.fw.dao.ibatis,ie.gov.fw.ejb.session.facade.panel,ie.gov.fw.exceptions.reports,ie.gov.fw.struts.forms.clientportal.campaign,ie.gov.fw.util.security,ie.gov.fw.struts.forms.candidateportal.application,ie.gov.fw.struts.forms.employeeportal.decentralisation,ie.gov.fw.struts.navigation.model,ie.gov.fw.struts,ie.gov.fw.exceptions.request,ie.gov.fw.dao.interfaces.staff,ie.gov.fw.struts.util.data,ie.gov.fw.business.util.documentmanagement.cms.impl,ie.gov.fw.struts.actions.employeeportal.exam.exams,ie.gov.fw.struts.forms.employeeportal.scoreactivities,ie.gov.fw.model.marking,ie.gov.fw.ejb.session.facade.board,ie.gov.fw.struts.forms.candidateportal.decentralisation,ie.gov.fw.struts.util.decorators.reporting,ie.gov.fw.model.contact,ie.gov.fw.struts.forms.employeeportal.contact.tracking,ie.gov.fw.struts.actions.employeeportal.application,ie.gov.fw.exceptions.test,ie.gov.fw.exceptions.staff,ie.gov.fw.ejb.util,ie.gov.fw.business.score,ie.gov.fw.model.reporting.custom.attendance.roll,ie.gov.fw.dao.interfaces.panel,ie.gov.fw.struts.actions.employeeportal.home,ie.gov.fw.struts.util.decorators,ie.gov.fw.delegate,ie.gov.fw.util.data,ie.gov.fw.dao.interfaces.marking,ie.gov.fw.struts.forms.employeeportal.reports,ie.gov.fw.struts.actions.employeeportal.decentralisation,ie.gov.fw.dao.ibatis.staff,ie.gov.fw.dao.ibatis.user,ie.gov.fw.exceptions.assessment,ie.gov.fw.business.util.documentmanagement.impl,ie.gov.fw.model.batch.print,ie.gov.fw.model.test" sourcepath="../phase3/src/java">
            <doclet name="com.sun.tools.doclets.doccheck.DocCheck" path="C:\software\doccheck1.2b2\doccheck.jar"/>
        </javadoc>
    </target>
</project>