Package com.sun.javadoc

Examples of com.sun.javadoc.RootDoc


   */
  public static ClassDoc getFullClassDoc(ClassDoc doc) throws Exception{
    Check.notNull(doc, "doc");
    File sourcefile = new ClassDocDelegate(doc).getSourcefile();
    Check.isTrue(sourcefile.exists(), "The file does not exist ", sourcefile);
    RootDoc fullRootDoc = DocUtils.createJavadocOfFile(sourcefile);
    Check.notNull(fullRootDoc, "fullRootDoc", "should be created from file " + sourcefile);
    ClassDoc fullClassDoc = fullRootDoc.classNamed(doc.qualifiedName());
    return fullClassDoc;
  }
View Full Code Here


  @Test
  @Example(clasz=FeatureCollector.class)
  public void example() throws Exception{
    //[gb:useInDocumentation]
    //get some rootDoc
    RootDoc rootDoc = createDefaultRootDoc();
    String link = "See </pre><a href='SampleClass.java.txt'  target='_blank'>the java sourcecode</a><pre>";
    // the file is created in the TestBoostedStandardDoclet.example
   
    link = "See </pre><a href='sampleFeaturesReport.html'  target='_blank'>the generated report</a><pre>";
    StringWriter report = new StringWriter();
View Full Code Here

    FileUtils.deleteDirectory(sourcecodeDir);
    FileUtils.deleteDirectory(expandingRootDocHandlerSampleDir);
  }
 
  public RootDoc createDefaultRootDoc() throws Exception{
    RootDoc doc =  DocBoostUtils.createJavadoc(sourcecodeDir, null);   
    return doc;
  }
View Full Code Here

    return doc;
  }

  public RootDoc createExpandingRootDocHandlerSampleRootDoc()
      throws Exception {
    RootDoc doc = DocBoostUtils.createJavadoc(
        expandingRootDocHandlerSampleDir, null);
    return doc;
  }
View Full Code Here

    //[gb:useInDocumentation]
    
     /*
      * If the handler is used in a doclet, the root doc is created by it.
      */
    RootDoc rootDoc = createDefaultRootDoc();
    String link = "See </pre><a href='SampleClass.java.txt'  target='_blank'>the java sourcecode</a><pre>";
    // the file is created in the TestBoostedStandardDoclet.example

    CollectionAppendingDocHandler<String> handler = new CollectionAppendingDocHandler<String>() {
      /**
 
View Full Code Here

  @Test
  @Example(clasz=JavadocCompletenessTester.class)
  public void example() throws Exception{
    //[gb:useInDocumentation]
    //get some rootDoc
    RootDoc rootDoc = createDefaultRootDoc();
    new ExpandingRootDocHandler().evaluate(rootDoc);
   
    StringWriter report = new StringWriter();
    new JavadocCompletenessTester().createDefaultReport(rootDoc, report);
View Full Code Here

  @Example(clasz = ExpandingRootDocHandler.class)
  public void exampleUse() throws Exception{
    // [gb:useInDocumentation]
    // get some rootDoc
    String sourcecode = getSampleSourcecode();
    RootDoc rootDoc = createDefaultRootDoc();
    String link = "See </pre><a href='SampleClass.java.txt'  target='_blank'>the java sourcecode</a><pre>";
    // the file is created in the TestBoostedStandardDoclet.example

    String originalReport = new JavadocCompletenessTester()
        .createDefaultReport(rootDoc);
View Full Code Here

   * Check that a given sourcecode has no missing comments after the
   * ExpandingRootDocHandler did its job.
   */
  @Test
  public void testCompleteness() throws Exception {
    RootDoc rootDoc = createExpandingRootDocHandlerSampleRootDoc();
    ExpandingRootDocHandler handler = new ExpandingRootDocHandler();
    rootDoc = handler.evaluate(rootDoc);

    StringWriter report = new StringWriter();
    JavadocCompletenessTester tester = new JavadocCompletenessTester();
View Full Code Here

  @Example(clasz = DeprecationsCollector.class)
  public void example() throws Exception{
    //[gb:useInDocumentation]

    //get some rootDoc
    RootDoc rootDoc = createDefaultRootDoc();
   
    StringWriter report = new StringWriter();
    DeprecationsCollector.createReport(rootDoc, report);

    String link = "See </pre><a href='SampleClass.java.txt'  target='_blank'>the java sourcecode</a><pre>";
View Full Code Here

  public void exampleUse() throws Exception{

    //TODO refactor dir.delete into method

    //[gb:useInDocumentation]
    RootDoc rootDoc =  createDefaultRootDoc();
    File dir = File.createTempFile("ExampleCreatingRootDocHandler", "dir");
    dir.delete();//delete the file because it is not a directory. it will be created later
    ExampleCreatingRootDocHandler handler = new ExampleCreatingRootDocHandler(
        dir, new ArrayList<File>());
    handler.evaluate(rootDoc);
View Full Code Here

TOP

Related Classes of com.sun.javadoc.RootDoc

Copyright © 2018 www.massapicom. All rights reserved.
All source code are property of their respective owners. Java is a trademark of Sun Microsystems, Inc and owned by ORACLE Inc. Contact coftware#gmail.com.