feedc0de/qt-creator
1
0
Fork 0
forked from qt-creator/qt-creator
Code Pull Requests Activity

Doc: Describe Documentation Comments preferences

Browse Source 
- Add a topic for setting preferences for Doxygen-style docs
- Update screenshot for Text Editor > Completion preferences, where
  the documentation settings used to be

Task-number: QTCREATORBUG-29392
Change-Id: Ifb915e78f3d2a5fb97555dd99bfaa5abf12ef14b
Reviewed-by: Christian Kandeler <christian.kandeler@qt.io>
This commit is contained in:
Leena Miettinen
2023-10-06 14:06:20 +02:00
parent 520cbfa39a
commit 551dde7fa9
8 changed files with 36 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

27
doc/qtcreator/src/howto/creator-only/creator-how-to-document-code.qdoc Normal file
View File

@@ -0,0 +1,27 @@
// Copyright (C) 2023 The Qt Company Ltd.
// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only
/*!
\page creator-how-to-document-code.html
\previouspage creator-how-tos.html
\ingroup creator-how-to-edit
\title Document code
When you write documentation comments in the \uicontrol 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 \uicontrol Projects > \uicontrol {Project Settings} >
\uicontrol {Documentation Comments}, and deselect the
\uicontrol {Use global settings} check box.
\image qtcreator-preferences-documentation-comments.webp {Documentation Comments settings}
To set global preferences, select \uicontrol Edit > \uicontrol Preferences >
\uicontrol {Text Editor} > \uicontrol {Documentation Comments}.
\sa {Configuring Projects}
*/

5
doc/qtcreator/src/howto/creator-only/creator-how-tos.qdoc
View File

@@ -28,6 +28,7 @@
\list
\li \l {Add code snippets to the auto-complete menu}
\li \l {Document code}
\li \l {Enclose selected code in curly braces, parentheses, or double quotes}
\li \l {Indent text or code}
\li \l {Jump to a function in QML code}
@@ -410,7 +411,9 @@
select \uicontrol Edit > \uicontrol Preferences >
\uicontrol {Text Editor} > \uicontrol Completion.
\image qtcreator-options-texteditor-completion.png "Completion preferences"
\image qtcreator-preferences-texteditor-completion.webp "Completion preferences"
\sa {Completing Code}
*/
/*!