Class HiLiteDetails

  • public class HiLiteDetails
    extends java.lang.Object
    Process Java Doc Web-Page: Syntax HiLiting for Source Code in Java Doc Details Sections.

    The primary use of this class is that it allows a user to request that the Java-Doc upgrade package hilite each and every detail-element within an (already existing) Java-Doc HTML Class, Enumerated-Type, or Interface Page.

    IMPORTANT: Constructors, by default, are ignored by the Upgrader Processing-Logic. In order to use this class to hilite them, the user needs to explicitly ask that all Constructors for a given class be hilited, using an Upgrader-Builder method.

    ALSO: Annotation Elements (both optional ones and required ones) are not, by default, hilited either. In order to request that Elements be code-hilited and inserted into their respective Java Doc HTML Pages, the user also needs to explicity ask the Upgrader to hilite Annotation Elements. The reasoning here is that, much like Enum Constants, there is just nothing more to hilite than what is already present in the 'signature' part of the documentation; and therefore hiliting the declarations would look superfluous and redundant.

    In cases where 'default' values are assigned to an Annotation Element, hiliting their declarations might help the reader visualize the purpose of an Annotation itself, and hiliting its declarations could potentially benefit other programmers trying to undertand its documentation.

    Note that most Java Source-Code files will not have such elements. Only in a Java Annotation (@interface) is it even possible to define an Annotation Element, and there are many @interface's that don't declare them at all.

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
  • 1 Method(s), 1 declared static
  • 6 Field(s), 6 declared static, 6 declared final