public class HiLiteFields extends java.lang.Object
HiLiteFields - Documentation.
The primary use of this class is that it allows a user to request that the Java-Doc upgrade package hilite each and every field within an (already existing) Java-Doc HTML Class, Enumerated-Type, or Interface Page.
NOTE: This class will only provide Field Declarations as Hilited Code. Constructors and Methods are not hilited here.
HiLite Field Declarationprocedure is the one which creates segments on your Java Doc Pages that look like:
Stateless Class: This class neither contains any program-state, nor can it be instantiated.
@StaticFunctionalAnnotation may also be called 'The Spaghetti Report'
- 1 Constructor(s), 1 declared private, zero-argument constructor
- 2 Method(s), 2 declared static
- 1 Field(s), 1 declared static, 1 declared final
public static int run(CommonParamRecord pr)This method will hilite all
Field'sthat are scraped from a Java Doc Generated HTML Documentation Page for a Class, Enumerated Type, or Interface. The hilited source-code is inserted into the Java-Doc HTML Web-Page in the
'Field Details'section for any / all
Field'sfound on the page.
pr- This contains all of the needed parameters for this method, encapsulated into a single record-class. The list is somewhat lengthy, so this makes the code "look cleaner"
- This will return a count on exactly how many
Field'shave had their code-hilited declarations inserted into the JavaDoc Documentation File for this class.
- Exact Method Body: