StackOverflow2013

Note that there are some explanatory texts on larger screens.

plurals

PO
text
Body
copied!<p>Looks you have only invoked <code>javadoc -help</code>. This is only a short reminder about the options, not a complete documentation.</p> <p>In principle, everything is explained in detail on the javadoc documentation page (for <a href="http://download.oracle.com/javase/6/docs/technotes/tools/windows/javadoc.html">Windows</a> and <a href="http://download.oracle.com/javase/6/docs/technotes/tools/solaris/javadoc.html">Linux/Solaris</a>).</p> <p>The <a href="http://download.oracle.com/javase/6/docs/technotes/tools/solaris/javadoc.html#tag"><code>-tag</code> option</a> is for adding custom tags to the standard doclet without having to create an own taglet (there you would use the <a href="http://download.oracle.com/javase/6/docs/technotes/tools/solaris/javadoc.html#taglet"><code>-taglet</code> option</a>) or even an own doclet.</p> <p>All the parameters to the option have to be one command line argument, so depending on your shell you usually have to put them (together or individually) in quotes if they contain any spaces.</p> <blockquote> <p><code>-tag</code> <em>tagname</em><code>:Xaoptcmf:</code>"<em>taghead</em>"</p> </blockquote> <ul> <li>The <em>tagname</em> is the name of your custom tag - for example, if you are writing <code>@todo</code> in the source, the name would be <code>todo</code>.</li> <li>The middle parameter is an identifier for the locations where this tag is allowed. This can be a combination of <code>a</code> (everywhere), <code>o</code> (only in the overview page), <code>p</code> (on package documentation), <code>t</code> (for class or interface documentation), <code>c</code> (for constructors), <code>m</code> (for methods), <code>f</code> (for fields). Additionally there can be an <code>X</code> meaning the tag is accepted but no output shown. (Then you don't need the <em>taghead</em> part).</li> <li>The <em>taghead</em> is what should be shown in the generated source as the header for your tag, for example <code>To Do:</code> for our todo-tag.</li> </ul> <p>So, if you <code>@todo</code> tag should be allowed everywhere and print <code>To Do:</code>, you would use</p> <pre><code>-tag todo:a:"To Do:" </code></pre>

Querying!

Guidance

An individual column

Larger individual text columns get their own page to allow for proper reading.

SQuiL has stopped working due to an internal error.

If you are curious you may find further information in the browser console, which is accessible through the devtools (F12).

Reload