com.sun.tools.doclets.standard.Standard Java Examples

/**
 * Entry point for this doclet.
 * This method modifies the standard doclet processing by wrapping each element in a proxy.
 * @param root the root of the document from which the javadoc is generated.
 * @return true if javadoc generation was succesful, false otherwise.
 * @throws java.io.IOException if an I/O exception occurs while generating the javadoc.
 */
public static boolean start(final RootDoc root) throws java.io.IOException {
  try {
    System.out.println("root doc = " + root.name());
    return Standard.start((RootDoc) process(root, RootDoc.class));
  } catch (IllegalArgumentException e) {
    System.out.println("IllegalArgumentException for root doc = " + root);
    throw e;
  }
}
 

/**
 * As specified by the Doclet specification.
 *
 * @param rootDoc The root doc.
 *
 * @return `true`, if process was successful.
 *
 * @see com.sun.javadoc.Doclet#start(RootDoc)
 */
public static boolean start(RootDoc rootDoc) {
    final MarkdownTaglets markdownTaglets = MarkdownTaglets.instance();
    Options options = new Options();
    String[][] forwardedOptions = options.load(rootDoc.options(), rootDoc);
    if ( forwardedOptions == null ) {
        return false;
    }
    MarkdownDoclet doclet = new MarkdownDoclet(options, rootDoc);
    markdownTaglets.setDocErrorReporter(doclet);
    doclet.process();
    if ( doclet.isError() ) {
        return false;
    }
    RootDocWrapper rootDocWrapper = new RootDocWrapper(rootDoc, forwardedOptions);
    if ( options.isHighlightEnabled() ) {
        // find the footer option
        int i = 0;
        for ( ; i < rootDocWrapper.options().length; i++ ) {
            if ( rootDocWrapper.options()[i][0].equals("-footer") ) {
                rootDocWrapper.options()[i][1] += HIGHLIGHT_JS_HTML;
                break;
            }
        }
        if ( i >= rootDocWrapper.options().length ) {
            rootDocWrapper.appendOption("-footer", HIGHLIGHT_JS_HTML);
        }
    }
    return Standard.start(rootDocWrapper) && doclet.postProcess();
}
 

public static int optionLength(String option) {
  Integer length = StabilityOptions.optionLength(option);
  if (length != null) {
    return length;
  }
  return Standard.optionLength(option);
}
 

public static int optionLength(String option) {
  Integer length = StabilityOptions.optionLength(option);
  if (length != null) {
    return length;
  }
  return Standard.optionLength(option);
}
 

public static int optionLength(String option) {
  Integer length = StabilityOptions.optionLength(option);
  if (length != null) {
    return length;
  }
  return Standard.optionLength(option);
}
 

public static int optionLength(String option) {
  Integer length = StabilityOptions.optionLength(option);
  if (length != null) {
    return length;
  }
  return Standard.optionLength(option);
}
 

public static boolean validOptions(String[][] options,
    DocErrorReporter reporter) {
  StabilityOptions.validOptions(options, reporter);
  String[][] filteredOptions = StabilityOptions.filterOptions(options);
  return Standard.validOptions(filteredOptions, reporter);
}
 

public static int optionLength(String option) {
  return Standard.optionLength(option);
}
 

public static boolean start(RootDoc root)
{
    return Standard.start( RootDocProcessor.process( root ) );
}
 

@SuppressWarnings( "unused" )
public static int optionLength(String option) {
    return Standard.optionLength(option);
}
 

@SuppressWarnings( "unused" )
public static boolean validOptions( String[][] options, DocErrorReporter reporter)
{
    return Standard.validOptions(options, reporter);
}
 

public static boolean start(RootDoc root) {
    return Standard.start((RootDoc) process(root, RootDoc.class));
}
 

public static boolean validOptions(String[][] options,
    DocErrorReporter reporter) {
  StabilityOptions.validOptions(options, reporter);
  String[][] filteredOptions = StabilityOptions.filterOptions(options);
  return Standard.validOptions(filteredOptions, reporter);
}
 

public static boolean start(RootDoc root) {
   System.out.println(
ExcludePrivateAnnotationsStandardDoclet.class.getSimpleName());
   return Standard.start(RootDocProcessor.process(root));
 }
 

public static boolean start(RootDoc root) {
  System.out.println(
      IncludePublicAnnotationsStandardDoclet.class.getSimpleName());
  RootDocProcessor.treatUnannotatedClassesAsPrivate = true;
  return Standard.start(RootDocProcessor.process(root));
}
 

public static boolean validOptions(String[][] options,
    DocErrorReporter reporter) {
  StabilityOptions.validOptions(options, reporter);
  String[][] filteredOptions = StabilityOptions.filterOptions(options);
  return Standard.validOptions(filteredOptions, reporter);
}
 

public static boolean start(RootDoc root) {
   System.out.println(
ExcludePrivateAnnotationsStandardDoclet.class.getSimpleName());
   return Standard.start(RootDocProcessor.process(root));
 }
 

public static boolean validOptions(String[][] options,
    DocErrorReporter reporter) {
  StabilityOptions.validOptions(options, reporter);
  String[][] filteredOptions = StabilityOptions.filterOptions(options);
  return Standard.validOptions(filteredOptions, reporter);
}
 

public static boolean start(RootDoc root) {
  System.out.println(
      IncludePublicAnnotationsStandardDoclet.class.getSimpleName());
  RootDocProcessor.treatUnannotatedClassesAsPrivate = true;
  return Standard.start(RootDocProcessor.process(root));
}
 

/**
 * As specified by the Doclet specification.
 *
 * @param options          The command line options.
 * @param errorReporter    An error reporter to print messages.
 *
 * @return `true` if the options are valid.
 *
 * @see com.sun.javadoc.Doclet#validOptions(String[][], com.sun.javadoc.DocErrorReporter)
 */
public static boolean validOptions(String[][] options, DocErrorReporter errorReporter) {
    options = new Options().load(options, errorReporter);
    if ( options != null ) {
        return Standard.validOptions(options, errorReporter);
    }
    else {
        return false;
    }
}
 

/**
 * Determine the number of arguments for each command line option (including the option name).
 * This method delegates its processing to the standard doclet.
 * @param option the option to check.
 * @return the expected number of arguments for the option.
 */
public static int optionLength(final String option) {
  return Standard.optionLength(option);
}
 

public static boolean start(RootDoc rootIBMDoc)  {

		return Standard.start((RootDoc) process(rootIBMDoc, RootDoc.class));
	}