diff --git a/doc/qtcreator/images/qtcreator-options-texteditor-completion.png b/doc/qtcreator/images/qtcreator-options-texteditor-completion.png deleted file mode 100644 index a891ed6365c..00000000000 Binary files a/doc/qtcreator/images/qtcreator-options-texteditor-completion.png and /dev/null differ diff --git a/doc/qtcreator/images/qtcreator-preferences-documentation-comments.webp b/doc/qtcreator/images/qtcreator-preferences-documentation-comments.webp new file mode 100644 index 00000000000..0e65dde2aeb Binary files /dev/null and b/doc/qtcreator/images/qtcreator-preferences-documentation-comments.webp differ diff --git a/doc/qtcreator/images/qtcreator-preferences-texteditor-completion.webp b/doc/qtcreator/images/qtcreator-preferences-texteditor-completion.webp new file mode 100644 index 00000000000..e2b68ec7852 Binary files /dev/null and b/doc/qtcreator/images/qtcreator-preferences-texteditor-completion.webp differ diff --git a/doc/qtcreator/src/editors/creator-code-completion.qdoc b/doc/qtcreator/src/editors/creator-code-completion.qdoc index a7a1b17c4a2..409855ab73d 100644 --- a/doc/qtcreator/src/editors/creator-code-completion.qdoc +++ b/doc/qtcreator/src/editors/creator-code-completion.qdoc @@ -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 diff --git a/doc/qtcreator/src/howto/creator-only/creator-how-to-document-code.qdoc b/doc/qtcreator/src/howto/creator-only/creator-how-to-document-code.qdoc new file mode 100644 index 00000000000..3050f4a9a4e --- /dev/null +++ b/doc/qtcreator/src/howto/creator-only/creator-how-to-document-code.qdoc @@ -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} +*/ diff --git a/doc/qtcreator/src/howto/creator-only/creator-how-tos.qdoc b/doc/qtcreator/src/howto/creator-only/creator-how-tos.qdoc index 94a4f288393..a716f7aede6 100644 --- a/doc/qtcreator/src/howto/creator-only/creator-how-tos.qdoc +++ b/doc/qtcreator/src/howto/creator-only/creator-how-tos.qdoc @@ -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} */ /*! diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-overview.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-overview.qdoc index 2b71e1f5000..3276706a95e 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-overview.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-overview.qdoc @@ -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} diff --git a/doc/qtcreator/src/qtcreator-toc.qdoc b/doc/qtcreator/src/qtcreator-toc.qdoc index 5fcbee47a94..bfc6e8122fa 100644 --- a/doc/qtcreator/src/qtcreator-toc.qdoc +++ b/doc/qtcreator/src/qtcreator-toc.qdoc @@ -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}