[sdk/umbrello] doc: doc: update the write section comments options
Luigi Toscano <[email protected]> Sat, 16 Aug 2025 14:38:00 +0000 (UTC)
| Newsgroups | gmane.comp.kde.cvs,gmane.comp.kde.doc |
|---|---|
| Message-ID | <[email protected]> |
Git commit 1dec9f91a7bc06f702e779a02440be02700d01ae by Luigi Toscano.
Committed on 16/08/2025 at 14:01.
Pushed by ltoscano into branch 'master'.
doc: update the write section comments options
Previously named "Write comments for sections even if section
is empty", its definition and behavior was changed 3 years ago
(Gear 23.04, see 5dc9f9c172376a4276eec1c153c2c241125f999c)
M +3 -3 doc/settings.docbook
https://invent.kde.org/sdk/umbrello/-/commit/1dec9f91a7bc06f702e779a02440be02700d01ae
diff --git a/doc/settings.docbook b/doc/settings.docbook
index 459ea8330..fd9d71f4d 100644
--- a/doc/settings.docbook
+++ b/doc/settings.docbook
@@ -341,9 +341,9 @@
<title>Comment Verbosity</title>
<para><guilabel>Write documentation comments even if empty</guilabel>
Generates comments for classes and functions even if they are empty.</para>
- <para><guilabel>Write comments for sections even if section is empty</guilabel>
- Writes comments for the private, protected and public sections even if
- they are empty.</para>
+ <para><guilabel>Write section comments</guilabel>
+ allow users to choose whether to write section comments.
+ The possibile values are: None, When section is non empty, Always.</para>
</sect3> <!-- code-gen-formatting-comment-verbosity -->
<sect3 id="code-gen-formatting-lines">