com.ullink

Class IKVMDocLet

java.lang.Object

com.sun.javadoc.Doclet

com.ullink.IKVMDocLet

public class IKVMDocLet
extends com.sun.javadoc.Doclet

Java Doclet for generating .NET XML API documentation.

The current implementation may has not been tested with (and thus may not support) the following features:

• ${@code} should be converted to <c> tags
• ${@docRoot} ${@inheritDoc} ${@literal} ${@value} references to package documentation annotations

Other issues:

 Usage reports "javadoc" instead of "ikvmdoc":
 
 usage: javadoc [options] [packagenames] [sourcefiles] [@files]
 
 should be:
  
 usage: ikvmdoc [options] [packagenames] [sourcefiles] [@files]
 

HTML tag parsing is not forgiving; should be made more fault tolerant

Javadoc HTML -> .NET tag conversions that should be considered/evaluated: true -> false -> null -> References: http://weblog.ikvm.net/CommentView.aspx?guid=0259c2c8-e9c1-4c92-88e5-5b459da76b86 http://ikvm.cvs.sourceforge.net/ikvm/ikvm/ikvmdoc/IKVMDoc.java?view=markup

Constructor Summary

Constructors

Constructor and Description
IKVMDocLet()

Method Summary

Methods

Modifier and Type	Method and Description
static void	main(java.lang.String[] args) Execute IKVMDoc without the use of the javadoc executable.
static int	optionLength(java.lang.String option) Check for ikvmdoc specific options.
static void	printIndent(java.io.PrintWriter pw, int indentations) Prints an indentation a specified number of times.
static boolean	start(com.sun.javadoc.RootDoc root) Generate the .NET XML Documentation.
static boolean	validOptions(java.lang.String[][] options, com.sun.javadoc.DocErrorReporter reporter) Check that ikvmdoc options have the correct arguments.

Methods inherited from class com.sun.javadoc.Doclet

languageVersion

Methods inherited from class java.lang.Object

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

Constructor Detail

IKVMDocLet

public IKVMDocLet()

Method Detail

start

public static boolean start(com.sun.javadoc.RootDoc root)

Generate the .NET XML Documentation.

Parameters:

root - represents the root of the program structure information for one run of javadoc

Returns:

true on success; false on failure

printIndent

public static void printIndent(java.io.PrintWriter pw,
               int indentations)

Prints an indentation a specified number of times.

Parameters:

pw - the writer to print the indentations to

indentations - the number of indentations to print

main

public static void main(java.lang.String[] args)

Execute IKVMDoc without the use of the javadoc executable.

Parameters:

args - the program arguments

optionLength

public static int optionLength(java.lang.String option)

Check for ikvmdoc specific options. Returns the number of arguments that must be specified on the command line for the given option. For example, "-assembly IKVM.OpenJDK.ClassLibrary.dll" would return 2.

Parameters:

option - the option to evaluate and return the number of arguments for

Returns:

number of arguments on the command line for an option including the option name itself. Zero return means option not known. Negative value means error occurred.

validOptions

public static boolean validOptions(java.lang.String[][] options,
                   com.sun.javadoc.DocErrorReporter reporter)

Check that ikvmdoc options have the correct arguments.

Parameters:

options - the options to check

reporter - the error reported used to report any failures to

Returns:

true if the options are valid; false if the options are invalid