forked from qt-creator/qt-creator
Doc: Describe Documentation Comments preferences
- 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:
Binary file not shown.
|
Before Width: | Height: | Size: 14 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 3.1 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 7.7 KiB |
@@ -31,7 +31,7 @@
|
||||
To specify settings for code completion, select \uicontrol Edit >
|
||||
\uicontrol Preferences > \uicontrol {Text Editor} > \uicontrol Completion.
|
||||
|
||||
\image qtcreator-options-texteditor-completion.png "Text Editor Completion preferences"
|
||||
\image qtcreator-preferences-texteditor-completion.webp "Text Editor Completion preferences"
|
||||
|
||||
By default, code completion does not consider case. To apply full or
|
||||
first-letter case-sensitivity, select \uicontrol Full or
|
||||
@@ -298,6 +298,8 @@
|
||||
To use Nimsuggest, you must install it on the development PC. Then select
|
||||
\uicontrol Edit > \uicontrol Preferences > \uicontrol Nim > \uicontrol Tools,
|
||||
and enter the path to the tool executable in the \uicontrol Path field.
|
||||
|
||||
\sa {Document code}
|
||||
\else
|
||||
\include qtcreator-variables.qdocinc qtcreator variables
|
||||
\endif
|
||||
|
||||
@@ -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}
|
||||
*/
|
||||
@@ -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}
|
||||
*/
|
||||
|
||||
/*!
|
||||
|
||||
@@ -42,6 +42,7 @@
|
||||
\li \l{Specify code style}{C++ Code Style}
|
||||
\li \l{Using Custom Output Parsers}{Custom Output Parsers}
|
||||
\li \l{Specify dependencies}{Dependencies}
|
||||
\li \l{Document code}{Documentation Comments}
|
||||
\li \l{Specify editor settings}{Editor}
|
||||
\li \l{Specifying Environment Settings}{Environment}
|
||||
\li \l{Applying Refactoring Actions}{Quick Fixes}
|
||||
|
||||
@@ -188,6 +188,7 @@
|
||||
\li Edit Code
|
||||
\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}
|
||||
|
||||
Reference in New Issue
Block a user