Open a .java
file in XXE.
XXE uses the Javadoc plug-in to convert the Java file on the fly to an equivalent XML file. Then, it associates a configuration with the newly opened Javadoc document. The XXE configuration file bundled with the plug-in (if deployed properly) creates a very handy Javadoc tool bar.
Move caret to the beginning of the line where the class is declared.
+-- Move caret here | |public abstract class Node {
Insert a doc
element here (for example, used Edit|Insert or simply click on the Insert doc icon of the Javadoc tool bar).
First sentence, ended by a period, should describe the purpose of the class. It may be followed by other sentences. Type these sentences in the text placeholder.
For example, in what follows, we just type a single sentence.
The sentences found at the beginning of a doc
/description
may be followed by any HTML 3.2 block (p
, pre
, ul
, ol
, dl
, table
, etc) if needed too.
For example, in what follows, we insert a p
after first sentence (use Edit|Insert or click on the Insert or add block icon of the Javadoc tool bar and choose the p entry).
The description
element may be followed by elements corresponding to Javadoc tags (@param
, @return
, @exception
, @see
, etc).
For example, in what follows, we insert a see after the description (explicitly select description
and then use Edit|Insert After or more simply, just click on the Add see icon of the Javadoc tool bar).
Documenting a field is similar to what has been described above. Move caret to the beginning of the line where the field is declared and insert a doc
element here.
+-- Move caret here | | public static final int ELEMENT = 4;
Documenting a method is similar to what has been described above. Move caret to the beginning of the line where the method is declared and insert a doc
element here.
+-- Move caret here | | public Tree getParent() { return parent; }