[libraries/ktextaddons] textautogeneratetext: Add more qdoc

Laurent Montel <[email protected]>
Newsgroups gmane.comp.kde.cvs
Message-ID <[email protected]>
Git commit fa51c764562671e0bb0d96b46996b6d52eea3697 by Laurent Montel.
Committed on 09/08/2026 at 20:37.
Pushed by mlaurent into branch 'master'.

Add more qdoc

M  +6    -0    textautogeneratetext/core/textautogeneratemessage.h
M  +12   -0    textautogeneratetext/core/textautogeneratereply.h
M  +1    -1    textautogeneratetext/core/textautogeneratesettings.h
M  +6    -0    textautogeneratetext/core/textautogeneratetextclient.h
M  +12   -0    textautogeneratetext/core/textautogeneratetextplugin.h
M  +7    -0    textautogeneratetext/widgets/availablemodel/textautogeneratemodelavailablelistview.h
M  +4    -1    textautogeneratetext/widgets/configure/textautogeneratetextconfigurepluginswidget.h
M  +32   -0    textautogeneratetext/widgets/plugintext/textautogenerateplugintextmanager.h

https://invent.kde.org/libraries/ktextaddons/-/commit/fa51c764562671e0bb0d96b46996b6d52eea3697

diff --git a/textautogeneratetext/core/textautogeneratemessage.h b/textautogeneratetext/core/textautogeneratemessage.h
index d46a0f4ef..55b2e60a6 100644
--- a/textautogeneratetext/core/textautogeneratemessage.h
+++ b/textautogeneratetext/core/textautogeneratemessage.h
@@ -25,6 +25,9 @@ class TEXTAUTOGENERATETEXT_EXPORT TextAutoGenerateMessage
 {
     Q_GADGET
 public:
+    /*!
+     * \brief The Sender enum
+     */
     enum class Sender : uint8_t {
         Unknown,
         User,
@@ -34,6 +37,9 @@ public:
     };
     Q_ENUM(Sender)
 
+    /*!
+     * \brief The MessageState enum
+     */
     enum MessageState {
         None = 0,
         HoverHighlight = 1,
diff --git a/textautogeneratetext/core/textautogeneratereply.h b/textautogeneratetext/core/textautogeneratereply.h
index 441d40585..0d6ac329f 100644
--- a/textautogeneratetext/core/textautogeneratereply.h
+++ b/textautogeneratetext/core/textautogeneratereply.h
@@ -40,12 +40,18 @@ class TEXTAUTOGENERATETEXT_EXPORT TextAutoGenerateReply : public QObject
     Q_OBJECT
 
 public:
+    /*!
+     * \brief The ToolCallArgument class
+     */
     struct TEXTAUTOGENERATETEXT_EXPORT ToolCallArgument {
         QString keyTool;
         QString value;
         [[nodiscard]] bool operator==(const ToolCallArgument &other) const;
     };
 
+    /*!
+     * \brief The ToolCallArgumentInfo class
+     */
     struct TEXTAUTOGENERATETEXT_EXPORT ToolCallArgumentInfo {
         QList<ToolCallArgument> toolCallArgument;
         QByteArray toolName;
@@ -53,6 +59,9 @@ public:
         [[nodiscard]] bool operator==(const ToolCallArgumentInfo &other) const;
     };
 
+    /*!
+     * \brief The Response class
+     */
     struct TEXTAUTOGENERATETEXT_EXPORT Response {
         QList<ToolCallArgumentInfo> info;
         QString response;
@@ -61,6 +70,9 @@ public:
         [[nodiscard]] bool hasToolCallArguments() const;
     };
 
+    /*!
+     * \brief The DownloadModelInfo class
+     */
     struct DownloadModelInfo {
         quint64 total = 0;
         quint64 completed = 0;
diff --git a/textautogeneratetext/core/textautogeneratesettings.h b/textautogeneratetext/core/textautogeneratesettings.h
index 29fb8d076..d074e60f3 100644
--- a/textautogeneratetext/core/textautogeneratesettings.h
+++ b/textautogeneratetext/core/textautogeneratesettings.h
@@ -51,7 +51,7 @@ public:
     [[nodiscard]] static QString defaultPrompt();
 
 private:
-    void save();
+    TEXTAUTOGENERATETEXT_NO_EXPORT void save();
     QString mSystemPrompt;
 };
 
diff --git a/textautogeneratetext/core/textautogeneratetextclient.h b/textautogeneratetext/core/textautogeneratetextclient.h
index 0299c2790..1b1874ccd 100644
--- a/textautogeneratetext/core/textautogeneratetextclient.h
+++ b/textautogeneratetext/core/textautogeneratetextclient.h
@@ -25,10 +25,16 @@ class TEXTAUTOGENERATETEXT_EXPORT TextAutoGenerateTextClient : public QObject
     Q_OBJECT
 public:
     // Add more status
+    /*!
+     * \brief The Status enum
+     */
     enum class Status : uint8_t {
         Unknown,
         Broken,
     };
+    /*!
+     * \brief The SupportedServer class
+     */
     struct SupportedServer {
         QString localizedName;
         QString identifier;
diff --git a/textautogeneratetext/core/textautogeneratetextplugin.h b/textautogeneratetext/core/textautogeneratetextplugin.h
index efdfa784d..537964f96 100644
--- a/textautogeneratetext/core/textautogeneratetextplugin.h
+++ b/textautogeneratetext/core/textautogeneratetextplugin.h
@@ -32,16 +32,25 @@ class TEXTAUTOGENERATETEXT_EXPORT TextAutoGenerateTextPlugin : public QObject
 {
     Q_OBJECT
 public:
+    /*!
+     * \brief The EngineType enum
+     */
     enum class EngineType : uint8_t {
         Local,
         Network,
     };
+    /*!
+     * \brief The ModelInfoNameAndIdentifier class
+     */
     struct TEXTAUTOGENERATETEXT_EXPORT ModelInfoNameAndIdentifier {
         QString modelName;
         QString identifier;
         [[nodiscard]] bool isValid() const;
     };
 
+    /*!
+     * \brief The SendToAssistantInfo class
+     */
     struct TEXTAUTOGENERATETEXT_EXPORT SendToAssistantInfo {
         QString message;
         QByteArray messageUuid;
@@ -50,6 +59,9 @@ public:
         QList<QByteArray> tools;
     };
 
+    /*!
+     * \brief The EditSendInfo class
+     */
     struct TEXTAUTOGENERATETEXT_EXPORT EditSendInfo {
         QString message;
         QByteArray messageUuid;
diff --git a/textautogeneratetext/widgets/availablemodel/textautogeneratemodelavailablelistview.h b/textautogeneratetext/widgets/availablemodel/textautogeneratemodelavailablelistview.h
index 993b635d0..94f25c84b 100644
--- a/textautogeneratetext/widgets/availablemodel/textautogeneratemodelavailablelistview.h
+++ b/textautogeneratetext/widgets/availablemodel/textautogeneratemodelavailablelistview.h
@@ -19,7 +19,14 @@ class TEXTAUTOGENERATETEXT_EXPORT TextAutoGenerateModelAvailableListView : publi
 {
     Q_OBJECT
 public:
+    /*!
+     * \brief TextAutoGenerateModelAvailableListView
+     * \param parent
+     */
     explicit TextAutoGenerateModelAvailableListView(QWidget *parent = nullptr);
+    /*!
+     * \brief ~TextAutoGenerateModelAvailableListView
+     */
     ~TextAutoGenerateModelAvailableListView() override;
 };
 }
diff --git a/textautogeneratetext/widgets/configure/textautogeneratetextconfigurepluginswidget.h b/textautogeneratetext/widgets/configure/textautogeneratetextconfigurepluginswidget.h
index 0c58d47e2..b2217c1be 100644
--- a/textautogeneratetext/widgets/configure/textautogeneratetextconfigurepluginswidget.h
+++ b/textautogeneratetext/widgets/configure/textautogeneratetextconfigurepluginswidget.h
@@ -31,9 +31,12 @@ public:
      */
     void save() override;
 
-private:
+    /*!
+     * \brief initialize
+     */
     void initialize() override;
 
+private:
     TEXTAUTOGENERATETEXT_NO_EXPORT void slotConfigureClicked(const QString &groupName, const QString &identifier);
     QList<PluginItem *> mPluginTextItems;
     QList<PluginItem *> mPluginToolsItems;
diff --git a/textautogeneratetext/widgets/plugintext/textautogenerateplugintextmanager.h b/textautogeneratetext/widgets/plugintext/textautogenerateplugintextmanager.h
index 5f00a9025..3e8398f2d 100644
--- a/textautogeneratetext/widgets/plugintext/textautogenerateplugintextmanager.h
+++ b/textautogeneratetext/widgets/plugintext/textautogenerateplugintextmanager.h
@@ -38,18 +38,50 @@ class TEXTAUTOGENERATETEXT_EXPORT TextAutoGeneratePluginTextManager final : publ
 {
     Q_OBJECT
 public:
+    /*!
+     * \brief ~TextAutoGeneratePluginTextManager
+     */
     ~TextAutoGeneratePluginTextManager() override;
+    /*!
+     * \brief self
+     * \return
+     */
     static TextAutoGeneratePluginTextManager *self();
 
+    /*!
+     * \brief pluginsList
+     * \return
+     */
     [[nodiscard]] QList<TextAutoGeneratePluginText *> pluginsList() const;
 
+    /*!
+     * \brief configGroupName
+     * \return
+     */
     [[nodiscard]] QString configGroupName() const;
+    /*!
+     * \brief configPrefixSettingKey
+     * \return
+     */
     [[nodiscard]] QString configPrefixSettingKey() const;
 
+    /*!
+     * \brief pluginDataList
+     * \return
+     */
     [[nodiscard]] QList<TextAddonsWidgets::PluginUtilData> pluginDataList() const;
 
+    /*!
+     * \brief pluginFromIdentifier
+     * \param identifier
+     * \return
+     */
     [[nodiscard]] TextAutoGeneratePluginText *pluginFromIdentifier(const QString &identifier) const;
 
+    /*!
+     * \brief generatePluginsInformation
+     * \return
+     */
     [[nodiscard]] QString generatePluginsInformation() const;
 
 private:
lmpx.com only provides a reader for public news (NNTP) servers. It is not affiliated with the servers or forums shown here and is not responsible for the content of articles, which is written by their respective authors.