How to create multiple levels of indentation in Javadoc?

DocumentationJavadocIndentationNested Lists

Documentation Problem Overview

Suppose, that as part of documenting your code (Javadoc) you want to indicate that the relationships between elements using deep indentation.

How can I create a nested list as:

  • some element
    • some other element
      • yet some other element

Documentation Solutions

Solution 1 - Documentation

<ul>
  <li>Element</li>
  <ul>
     <li>Subelement...</li>

You can pretty freely use HTML inside javadoc comments.

Update: Because it came up, I tried

<ul>
    <li>one</li>
    <ul>
        <li>one point one</li>
    </ul>   
</ul>

and get

  • one
    • one point one

I agree proper nesting is better.

Solution 2 - Documentation

The correct way is as follows:

/**
 * <ul>
 *   <li>some element
 *   <li><ul>
 *     <li>some other element
 *     <li><ul>
 *       <li>yet some other element
 *     </ul>
 *   </ul>
 * </ul>
 */

Although JavaDoc borrows from HTML, it isn't HTML, and you should omit the </li> tags, just as you should omit </p> tags.

Solution 3 - Documentation

The nested list should be within its own <li>. <ul> is not a valid child element of <ul>.

So your example would be:

<ul>
  <li>some element</li>
  <li>
    <ul>
      <li>some other element</li>
      <li>
        <ul>
          <li>yet some other element</li>
        </ul>
      </li>
    </ul>
  </li>
</ul>
Categories
Recommended Documentation Solutions
Recommended Javadoc Solutions
Recommended Indentation Solutions
Recommended Nested Lists Solutions

Previous Solution:

$(this) inside of AJAX success not working

Jquery

Next Solution:

Can mustache iterate a top-level array?

JavascriptMustache

Attributions

All content for this solution is sourced from the original question on Stackoverflow.

The content on this page is licensed under the Attribution-ShareAlike 4.0 International (CC BY-SA 4.0) license.

Content TypeOriginal AuthorOriginal Content on Stackoverflow
QuestionJames RaitsevView Question on Stackoverflow
Solution 1 - DocumentationCharlie MartinView Answer on Stackoverflow
Solution 2 - DocumentationSeverityOneView Answer on Stackoverflow
Solution 3 - DocumentationDrew NoakesView Answer on Stackoverflow