Class CleanSummaries

  • public class CleanSummaries
    extends java.lang.Object
    Process Java Doc Web-Page: Remove the auto-generated summaries for each Method, Field, Constructor, Enum-Constant, and Annotation-Element in the Summary Section.

    JD-Upgrader Internally Used Class, Methods are Package-Private

    There is largely no use for these methods outside of the Java Doc Upgrader Application. Little Java-Doc Style Documentation will be provided here. The code itself (and code comments) may be viewed using the HiLited Source Code Button in the Navigation-Bar, or the URL-Link that is lower on this page.

    To see how this Upgrader Application class works, click the HiLited Source Code Link above.

    The class is the class responsible for removing summary-descriptions from Fields, Methods, Constructors and Enumerated Constants "Field Summary", "Method Summary", and "Constructor Summary" summary sections of a JavaDoc Web-Page. Currently there is no functionality for inserting simple first-line sentences into a JavaDoc CIET Web-Page.

    First, the page is more readable without the "AI Driven" Java Taglet that is supposed to parse and figure out the "First Line Summaries" in the Summary Sections. The Taglet often inserts spurious HTML Dividers and makes it unreadable. Second, using good method and field names usually makes the single "Summary Sentence" kind of extraneous.

    Cleaned Summaries look as in the picture below:

    Cleaned Summaries

Stateless Class: This class neither contains any program-state, nor can it be instantiated. The @StaticFunctional Annotation may also be called 'The Spaghetti Report'. Static-Functional classes are, essentially, C-Styled Files, without any constructors or non-static member field. It is very similar to the Java-Bean @Stateless Annotation.
  • 1 Constructor(s), 1 declared private, zero-argument constructor
  • 5 Method(s), 5 declared static
  • 7 Field(s), 7 declared static, 7 declared final

    • Method Summary

      • Methods inherited from class java.lang.Object

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