3. Documentation Comment Markup

3.1. Documentation Comment Structure

/**
 * [brief description]
 *
 * [long description]
 *
 * [taglets]
 */

Note

When no comments are present, Valadoc will only extract symbols to use in the documentation.

In this chapter, we'll explain how to fill each section of a documentation comment.

• 3.1.1. Brief Description
• 3.1.2. Formatting
• 3.1.3. Taglets
• 3.1.4. Contributing to Valadoc