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 deselect the Use global settings check box.

{Documentation Comments settings}

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

See also Configuring Projects.

© 2024 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.