public class EmbedTag extends java.lang.Object
JavaDoc EmbedTag - Documentation.
This class is capable of finding and replacing specified HTML "EMBED" Elements (<EMBED>) and replacing them with externally-located HTML pages. It does this by requiring that the tag have a
class='external-html'attribute and also an inner-tag that specifies an ID for that piece of HTML. This is in the form of
DATA-FILE-ID='SOME-ID-TOKEN'. When the Upgrader finds an HTML Embed element in the page whose class is
external-html, it will search for this
'Data-File-ID'attribute in the element, and then use a user-provided lookup-table, or lambda function, to insert that HTML into the class.
VALUE ADDED: This can allow programmers to type longer descriptions - particularly for elements such as the top-level class descriptions - in separate files from their source-code, if they so chose. A separate directory for longer HTML explanations for a class functionality or description can contain
'.html' filesthat may automatically imported into their javadoc's using the HTML Embed Element and this tool.
Hopefully, this simple example of how to insert an HTML 'EMBED' Element into a Java-Doc Documentation Comment Page will make it easier to add External HTML Files directly into code documentation. Please notice the
'Attribute'in the example named
'DATA-FILE-ID'. This is a token that must be defined in the
Embed Tags DefinitionsThis definitions list is simply a list of
HTML FileNames- separated by white-space, one-per-line that has been passed or registered with the Upgrader. See the Upgrader's method
setEmbedTagsMap(...)for more details.
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
- 5 Method(s), 5 declared static
- 4 Field(s), 4 declared static, 4 declared final
public static int run(CommonParamRecord pr)This method will load external HTML into a JavaDoc HTML 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 HTML Embed Elements were identified and replaced.
- Exact Method Body: