diff options
| author | Arttu Tarkiainen <arttu.tarkiainen@qt.io> | 2020-09-16 18:14:44 +0300 |
|---|---|---|
| committer | Arttu Tarkiainen <arttu.tarkiainen@qt.io> | 2020-09-21 06:44:32 +0000 |
| commit | 17f3e4fb3a2e560131527f91ca64944667223bd9 (patch) | |
| tree | 483eb0e64b5cf4adcab969bedaa88dba3d2b83ce /src/libs/installer/protocol.cpp | |
| parent | 7b16ab246d5c8241f08c0ffa3a87c9803ec4aa50 (diff) | |
Doc: Reduce the amount of documentation warnings
Miscellaneous fixes to missing function documentation, undocumented
parameters, namespace scope etc. As 5.12.7 based qdoc gives a lot
more warnings about code missing documentation, mark undocumented
implementation details with \internal command. Also some spelling
fixes to related parts of documentation.
Task-number: QTIFW-1483
Change-Id: Ibf5d1e5098713acbd152c5b61ea4f46cc11feb4b
Reviewed-by: Katja Marttila <katja.marttila@qt.io>
Diffstat (limited to 'src/libs/installer/protocol.cpp')
| -rw-r--r-- | src/libs/installer/protocol.cpp | 20 |
1 files changed, 20 insertions, 0 deletions
diff --git a/src/libs/installer/protocol.cpp b/src/libs/installer/protocol.cpp index d68af1722..3bafc481e 100644 --- a/src/libs/installer/protocol.cpp +++ b/src/libs/installer/protocol.cpp @@ -34,6 +34,26 @@ namespace QInstaller { typedef qint32 PackageSize; /*! + \inmodule QtInstallerFramework + \namespace Protocol + \brief Contains values related to the internal client-server connection protocol. +*/ + +/*! + \enum Protocol::Mode + + \value Debug + \value Production +*/ + +/*! + \enum Protocol::StartAs + + \value User + \value SuperUser +*/ + +/*! Write a packet containing \a command and \a data to \a device. \note Both client and server need to have the same endianness. |