Example #1
0
  /**
   * The entry point for processing provides an object to access the various attributes of all the
   * classes being documented.
   *
   * @param rootDoc the root of the documentation tree
   * @return some boolean value
   */
  public static boolean start(RootDoc rootDoc) {
    ClassDoc[] classes;
    Iterator i = null;
    readConfig();
    my_initialize();
    classes = rootDoc.classes();
    i = m_pipeline.values().iterator();

    while (i.hasNext()) {
      tool = (FeatureTool) i.next();
      for (int i = 0; i < classes.length; i++) {
        m_commentQualityRecords.add(tool.process(classes[i]));
      }
    }

    // correlate/aggregate quality reports

    // display quality reports

    return true;
  }