xbn.programs
Class ReportBadJDLinkCodes

java.lang.Object
  |
  +--xbn.XBNObject
        |
        +--xbn.programs.ReportBadJDLinkCodes

public class ReportBadJDLinkCodes

extends XBNObject

An application to test and report on the validity of all JavaDoc Link Codes. A pre-requisite for using this application is to actually put a JavaDoc Link Code into your source code. This application won't break if you don't have any jdlcodes, it'll just result in "0 links found, 0 links bad".

Source code: ReportBadJDLinkCodes.java.

Although not directly related to JavaDoc links, this application also verifies that all source code links (like right below) point to existing files.

In the report, a valid JavaDoc Link Code is denoted by ".". An invalid one denoted by "x". There are many options (command line parameters) for customizing this report.

This process cannot catch errors regarding indirect JavaDoc Link Codes. Indirect-related errors are only detected by the javadoc process (using the XBNDoclet). Unfortunately, there is no easy way to report these errors as a whole. javadoc will crash at the first error it finds (indirect or not), and inform you only of it.

This application uses UtilJDLCode.reportJDLinkCodeErrors for the actual analysis.

Fields inherited from class xbn.XBNObject

bFALSE_IN_PRODUCTION, bTRUE_IN_PRODUCTION, sCNSTR, sES, sLINE_SEP

Constructor Summary

ReportBadJDLinkCodes()

Method Summary

static void

main(String[] as_cmdLineParams) Run the application.

Methods inherited from class xbn.XBNObject

getXMsgPrefix, sop, sopl, sopl, throwAX, throwAXIfBadStr, throwAXIfNull, throwAXSpoof

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ReportBadJDLinkCodes

public ReportBadJDLinkCodes()

Method Detail

main

public static void main(String[] as_cmdLineParams)

Run the application.