[libraries/ktextaddons] textautogeneratetextmcpprotocol/core/server: Add qdoc
Laurent Montel <[email protected]>
| Newsgroups | gmane.comp.kde.cvs |
|---|---|
| Message-ID | <[email protected]> |
Git commit d1919f8a6e99e87dda49d2ebe4501ba8eb7935b5 by Laurent Montel.
Committed on 07/08/2026 at 17:58.
Pushed by mlaurent into branch 'master'.
Add qdoc
M +41 -0 textautogeneratetextmcpprotocol/core/server/mcpprotocolserver.h
M +0 -1 textautogeneratetextmcpprotocol/core/server/mcpserver.cpp
M +83 -1 textautogeneratetextmcpprotocol/core/server/mcpserver.h
https://invent.kde.org/libraries/ktextaddons/-/commit/d1919f8a6e99e87dda49d2ebe4501ba8eb7935b5
diff --git a/textautogeneratetextmcpprotocol/core/server/mcpprotocolserver.h b/textautogeneratetextmcpprotocol/core/server/mcpprotocolserver.h
index 099a3a874..13fb71963 100644
--- a/textautogeneratetextmcpprotocol/core/server/mcpprotocolserver.h
+++ b/textautogeneratetextmcpprotocol/core/server/mcpprotocolserver.h
@@ -11,23 +11,64 @@
#include <TextAutoGenerateTextMcpProtocolCore/McpProtocolSettings>
namespace TextAutoGenerateTextMcpProtocolCore
{
+/*!
+ * \class TextAutoGenerateTextMcpProtocolCore::McpProtocolServer
+ * \brief The McpProtocolServer class
+ * \author Laurent Montel <[email protected]>
+ * \inmodule TextAutoGenerateText
+ * \inheaderfile TextAutoGenerateTextMcpProtocolCore/McpProtocolServer
+ */
class TEXTAUTOGENERATETEXTMCPPROTOCOLCORE_EXPORT McpProtocolServer : public QObject
{
Q_OBJECT
public:
+ /*!
+ * \brief McpProtocolServer
+ * \param protocolType
+ * \param parent
+ */
explicit McpProtocolServer(McpProtocolPlugin::TransportType protocolType, QObject *parent = nullptr);
+ /*!
+ * \brief ~McpProtocolServer
+ */
~McpProtocolServer() override;
+ /*!
+ * \brief protocolType
+ * \return
+ */
[[nodiscard]] TextAutoGenerateTextMcpProtocolCore::McpProtocolPlugin::TransportType protocolType() const;
+ /*!
+ * \brief setSettings
+ * \param settings
+ */
void setSettings(const McpProtocolSettings &settings);
+ /*!
+ * \brief start
+ */
void start();
+ /*!
+ * \brief canStart
+ * \return
+ */
[[nodiscard]] bool canStart() const;
Q_SIGNALS:
+ /*!
+ * \brief started
+ */
void started();
+ /*!
+ * \brief received
+ * \param obj
+ */
void received(const QJsonObject &obj);
+ /*!
+ * \brief error
+ * \param str
+ */
void error(const QString &str);
private:
diff --git a/textautogeneratetextmcpprotocol/core/server/mcpserver.cpp b/textautogeneratetextmcpprotocol/core/server/mcpserver.cpp
index 79e870352..182bcd7e9 100644
--- a/textautogeneratetextmcpprotocol/core/server/mcpserver.cpp
+++ b/textautogeneratetextmcpprotocol/core/server/mcpserver.cpp
@@ -158,7 +158,6 @@ QDebug operator<<(QDebug d, const TextAutoGenerateTextMcpProtocolCore::McpServer
d.space() << "name:" << t.name();
d.space() << "identifier:" << t.identifier();
d.space() << "serverType:" << t.transportType();
-
d.space() << "settings:" << t.settings();
return d;
}
diff --git a/textautogeneratetextmcpprotocol/core/server/mcpserver.h b/textautogeneratetextmcpprotocol/core/server/mcpserver.h
index b8cdf7587..785300faf 100644
--- a/textautogeneratetextmcpprotocol/core/server/mcpserver.h
+++ b/textautogeneratetextmcpprotocol/core/server/mcpserver.h
@@ -15,37 +15,119 @@ class QDebug;
class KConfigGroup;
namespace TextAutoGenerateTextMcpProtocolCore
{
+/*!
+ * \class TextAutoGenerateTextMcpProtocolCore::McpServer
+ * \brief The McpServer class
+ * \author Laurent Montel <[email protected]>
+ * \inmodule TextAutoGenerateText
+ * \inheaderfile TextAutoGenerateTextMcpProtocolCore/McpServer
+ */
class TEXTAUTOGENERATETEXTMCPPROTOCOLCORE_EXPORT McpServer
{
Q_GADGET
public:
+ /*!
+ * \brief McpServer
+ */
McpServer();
+ /*!
+ * \brief ~McpServer
+ */
~McpServer();
+ /*!
+ * \brief createUniqueIdentifier
+ */
void createUniqueIdentifier();
+ /*!
+ * \brief enabled
+ * \return
+ */
[[nodiscard]] bool enabled() const;
+ /*!
+ * \brief setEnabled
+ * \param newEnabled
+ */
void setEnabled(bool newEnabled);
-
+ /*!
+ * \brief name
+ * \return
+ */
[[nodiscard]] QString name() const;
+ /*!
+ * \brief setName
+ * \param newName
+ */
void setName(const QString &newName);
+ /*!
+ * \brief identifier
+ * \return
+ */
[[nodiscard]] QByteArray identifier() const;
+ /*!
+ * \brief setIdentifier
+ * \param newIdentifier
+ */
void setIdentifier(const QByteArray &newIdentifier);
+ /*!
+ * \brief load
+ * \param config
+ */
void load(const KConfigGroup &config);
+ /*!
+ * \brief save
+ * \param config
+ */
void save(KConfigGroup &config) const;
+ /*!
+ * \brief isValid
+ * \return
+ */
[[nodiscard]] bool isValid() const;
+ /*!
+ * \brief transportType
+ * \return
+ */
[[nodiscard]] TextAutoGenerateTextMcpProtocolCore::McpProtocolPlugin::TransportType transportType() const;
+ /*!
+ * \brief setTransportType
+ * \param newServerType
+ */
void setTransportType(TextAutoGenerateTextMcpProtocolCore::McpProtocolPlugin::TransportType newServerType);
+ /*!
+ * \brief convertTransportTypeToString
+ * \param type
+ * \return
+ */
[[nodiscard]] static QString convertTransportTypeToString(TextAutoGenerateTextMcpProtocolCore::McpProtocolPlugin::TransportType type);
+ /*!
+ * \brief convertTransportTypeFromString
+ * \param str
+ * \return
+ */
[[nodiscard]] static TextAutoGenerateTextMcpProtocolCore::McpProtocolPlugin::TransportType convertTransportTypeFromString(const QString &str);
+ /*!
+ * \brief transportTypeI18n
+ * \param type
+ * \return
+ */
[[nodiscard]] static QString transportTypeI18n(TextAutoGenerateTextMcpProtocolCore::McpProtocolPlugin::TransportType type);
+ /*!
+ * \brief settings
+ * \return
+ */
[[nodiscard]] TextAutoGenerateTextMcpProtocolCore::McpProtocolSettings settings() const;
+ /*!
+ * \brief setSettings
+ * \param newSettings
+ */
void setSettings(const TextAutoGenerateTextMcpProtocolCore::McpProtocolSettings &newSettings);
private: