Document code | Qt Creator Documentation

- Qt Creator Documentation
- Document code
- Qt Creator 17.0.1

How To

# Document code

When you write documentation comments in the Edit mode, you can enable Doxygen code blocks and add brief descriptions and leading asterisks automatically. Also, you can select the Doxygen command prefix to use.

To set preferences for documentation comments for a particular project, select Projects > Project Settings > Documentation Comments, and clear the Use global settings check box.

To set global preferences, select Preferences > Text Editor > Documentation Comments.

See also Configuring Projects.

How To