Torello.HTML.Tools.JavaDoc

This package utilizes the value of an HTML Parser and Search Engine for allowing a user to transform, modify, add-to, and delete HTML nodes (automatically) into an HTML page. The package JavaDoc does this for programmers who would like to do things like automatically add code-hilited code-snippets, for example, directly onto their professionally written Java-Doc Comment-HTML Pages.

There is a Java-Parser Library that is required to use this Package. The Java Doc Upgrader Package / Tool will not work without this '.jar' file being placed in your CLASSPATH environment-variable. That '.jar' is available here:

http://developer.torello.directory/ralphsReference/jars/javaparser-core-3.16.2.jar

Primary User API

Java Entity	Description
Upgrade	The primary builder and configuration class for the Java Doc Upgrade Process, having many customizations that may be requested using the customize-settings methods available here

Reflection API (Optional Use)
Java Entity	Description
JavaDocHTMLFile	Retains all information parsed from a `'.html'` Java-Doc web-page, and borrows any missing information that was found in the `'.java'` source-code file; note that an instance-reference of this class may be rerieved, and used, to further change a Java Doc page by registering a visitor-handler with the configuration class `Upgrade` by calling `Upgrade`
SummaryTableHTML<ENTITY extends Declaration>	This class stores the HTML for a Summary-Table - which is the table at the top of a Java Doc Page listing all of one type of entities present in the CIET/Type
ReflHTML<ENTITY extends Declaration>	This class stores the HTML Detail-Descriptions retrieved from a Java Doc web-page 'Details Section', and simultaneously, holds the reflection-data extracted from the `'.java'` corresponding source-code files - facilitating all changes to a Java Doc Page deemed necessary
HeaderFooterHTML	Encapsulates the HTML placed both the top and the bottom of a JavaDoc Web-Page, including the Navigation-Bar HTML, the Package-Name, Type-Signature and other Banner-Labesl

AnnotationElem	Java Parser Bridge: Holds all information extracted from `'.java'` Annotation (`@interface`) Source Files about all Elements identified in that file
EnumConstant	Java Parser Bridge: Holds all information extracted from `'.java' enum` Source Files about Enumerated Constants's identified in that `'enum'` file
Constructor	Java Parser Bridge: Holds all information extracted from `'.java'` Source Files about Constructor's identified in that file
Field	Java Parser Bridge: Holds all information extracted from `'.java'` Source Files about Field's identified in that file
Method	Java Parser Bridge: Holds all information extracted from `'.java'` Source Files about Method's identified in that file
NestedType	Java Parser Bridge: Holds all information extracted from `'.java'` Source-Files regarding Nested-Types (Inner-Classes)

Callable	Java Parser Bridge: Common-Root Ancestor Class of both `Method` and `Constructor`
Declaration	Java Parser Bridge: Common-Root Ancestor Class of all Bridge Data-Classes

Annotations (Optional Use)
Java Entity	Description
StaticFunctional	Java-Annotation: A Java-Annotation for marking classes as 'Stateless Classes' - used to insert 'The Spaghetti Report' into Java Doc Pages
JDHeaderBackgroundImg	Java-Annotation: A Java-Annotation for inserting a Wooden-Plank Background Image at the top of a Java-Doc Page using External-HTML File's; the image used is configurable, and my be changed by assigning the Annotation-Element Values appropriately

HiLiter (Internal Use)
Java Entity	Description
HiLiter	A simple Functional-Interface allowing a user to swap in any customized, alternate or proprietary Syntax HiLiter to replace the default HiLiter used by this Upgrader Tool

HTML Processors (Internal Use)
Java Entity	Description
ExtraFilesProcessor	Process Java Doc Web-Page: PROCESSING-LOOP FOR ALL JAVADOC-GENERATED NON-CIET (NON-TYPE DECLARATION) WEB-PAGES
MainFilesProcessor	Process Java Doc Web-Page: PRIMARY PROCESSING-LOOP FOR ALL IMPLEMENTED HTML-PROCESSORS
DetailsProcessor	Process Java Doc Web-Page: PRIMARY PROCESSING-LOOP FOR ALL DETAIL-SECTION ELEMENTS

CleanPackageSummaries	Process Java Doc Web-Page: Simple utility for modifying Java Doc Package-Summary Files, using a user-provided function-pointer or lamda
CleanSummaries	Process Java Doc Web-Page: Remove the auto-generated summaries for each Method, Field, Constructor, Enum-Constant, and Annotation-Element in the Summary Section
Convenience	Process Java Doc Web-Page: Replace documentation-HTML for overloaded Methods & Constructors tagged with the key-word 'Convenience'
EmbedTag	Process Java Doc Web-Page: Replace <EMBED CLASS='external-html'> tags in code-comments with their respective External-HTML Files
EmbedTagParameters
HiLiteDetails	Process Java Doc Web-Page: Syntax HiLiting for Source Code in Java Doc Details Sections
HiLiteDividers	Process Java Doc Web-Page: Syntax HiLiting for In-Line Comment Source-Code
HiLiteSrcCodeFile	Process Java Doc Web-Page: Inserts link to a complete `'.java'` HiLited Source-File Page into a Java Doc Page
LinksChecker	Process Java Doc Web-Page: Checks for valid URL-Anchor Links inside the Java Doc Web-Page Tree
NavButtons	Process Java Doc Web-Page: Add several buttons to the Navigation Menu, along with a Detail-Element drop-down menu
SignatureParse	Process Java Doc Web-Page: Build bare-bones / stripped-down instances of a `Method`, `Field`, `Constructor`, etc - constructed from the "signature-only" information provided by Summary-Tables (or Detail-Headers)
SkewedParameters	Process Java Doc Web-Page: Does some repair on the Code-Signatures in both the Detail-Sections, and the Summary-Sections
StatelessClasses	Process Java Doc Web-Page: Makes use of the Java HTML Library `StaticFunctional` Annotation to insert a Spaghetti Report™ into the web-pages for classes that were annotated with it

CSSTags	Process Java Doc Web-Page: Complete List of CSS `CLASS` and `ID` Attributes that are inserted by the HTML Processor Classes `CSSTagsTopAndSumm` and `CSSTagsDetails`
CSSTagsTopAndSumm	Process Java Doc Web-Page: Insert Java Doc Upgrade CSS Attributes into Summary Section Elements, and other miscellaneous parts of a Java Doc HTML Page
CSSTagsDetails	Process Java Doc Web-Page: Insert Java Doc Upgrade CSS Attributes into Detail Section Elements

RearrangePkgFrame	Process Java Doc Web-Page: Organizes `CIET` items and generates sub-header labels for Java Doc Package-Summary and Package-Frame HTML-Files, by way of user-provided configuration classes
RetrieveSummarySorters	Process Java Doc Web-Page: Loads a user-provided `SummarySorter` class-file from disk
RearrangeEntitySummaries	Process Java Doc Web-Page:
SummarySorterHelper	Process Java Doc Web-Page: An abstract helper class for user-provided `SummarySorter`

Java-Source Internal Processors
Java Entity	Description
AnnotationsMirror	Annotation-Processing Class: A Java Annotation-Mirror used as a 'data-class' to hold the actual values (during upgrade processing) that the user has actually assigned to an Annotation inside his or her `'.java'` source-files
JDAnnotationsProcessor	Annotation-Processing Class: Top-Level Dispatch Annotation-Processor for both JavaDoc-Upgrader Annotations

HELPER	Process a Java Source-File: SOURCE-CODE PARSING HELPER-CLASS
JavaSourceCodeFile	Process a Java Source-File: PRIMARY JAVA-PARSER SOURCE-CODE PARSING CLASS
Stats	Process a Java Source-File: MAINTAINS STATISTICS ABOUT ALL JAVA-PROJECT SOURCE-FILES

Internal Utility Classes
Java Entity	Description
Details	Java Doc HTML-File Reader: Find and retrieve the entities of any of the five Java Doc generated Detail Sections
JDFiles	Retrieve Java Doc HTML Files from the Java Doc output directory
Messager	A replacement for `System.out, System.err` and even the `StorageWriter` class used to send error messages to the terminal about upgrade progress
PackageSummary	Java Doc HTML-File Reader: Find and retrieve any of the parts of Java Doc Package-Summary HTML-File
ParsedFile	Parent-class of both `JavaSourceCodeFile` and `JavaDocHTMLFile`
PF	Print Flags: Flag-Constants for pretty-printing and selecting output to Reflection API classes' `toString(flags)` methods

Enums
Java Entity	Description
CIET	CIET: Class, Interface, Enumerated-Type, Annotation (@interface) or Java 17+ Record
Entity	Entity: Exhaustive list of all items that may be defined inside of a Java Type
Excuse	An enumeration used by the `StaticFunctional` annotation for explaining non-`static` fields in a type
JDUProcessor	Enumeration containing the complete list of Java-Doc Upgrader Processing classes utilized by this Application

Exceptions & Errors
Java Entity	Description
DetailsException	Exception that may be thrown when erroneous-input is provided to class `Details` or `ReflHTML`
HiLiteException	Exception that may be thrown by the `HiLiter` interface
UpgradeException	Exception that may be thrown when building an `Upgrade` class instance

ParseException	Parent class for both `SourceCodeParseException` and `JavaDocHTMLParseException`
JavaDocHTMLParseException	Exception when parsing a Java Doc Generated HTML Web-Page File
SourceCodeParseException	Exception parsing a Java Source Code File

HiLiteError	General Purpose Code-Hiliting Error
JavaDocError	General Purpose Program Flow Error

Package Torello.HTML.Tools.JavaDoc