public class HiLiteConstructors extends java.lang.Object
HiLiteConstructors - Documentation.
The primary use of this class is that it allows a user to request that the Java-Doc upgrade package hilite
Constructorswithin an (already existing) Java-Doc HTML Class or Enumerated-Type.
NOTE: This class will only provide Contructor Declarations as Hilited Code,
Methodsare hilited with other classes.
Constructors, by default, are ignored by the Upgrader Processing-Logic. In order to use this class, the user needs to explicitly ask that all
Constructorsfor a given class be hilited, using an Upgrader-Builder method.
HiLite Constructor Declarationprocedure is the one which creates segments on your Java Doc Pages that look like:
- View Here: Torello/HTML/Tools/JavaDoc/HiLiteConstructors.java
- Open New Browser-Tab: Torello/HTML/Tools/JavaDoc/HiLiteConstructors.java
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
Constructor'sthat are scraped from a Java Doc Generated HTML Documentation Page for a Class, Enumerated Type, or Interface. Hilited source-code for constructor-bodies (as
String's) are inserted into the Java-Doc HTML Web-Page in the
'Constructor Details'section for any / all
Constructor'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
Constructor'shave had their code-hilited
Constructor-bodies inserted into the JavaDoc Documentation File for this class.
- Exact Method Body: