diff options
| author | Leena Miettinen <riitta-leena.miettinen@digia.com> | 2013-06-05 14:29:24 +0200 |
|---|---|---|
| committer | Leena Miettinen <riitta-leena.miettinen@digia.com> | 2013-06-20 11:22:47 +0200 |
| commit | 41411165bac561d3cd93a793c6ae76dcb2937e12 (patch) | |
| tree | cc9e5e516899407448ad8eadd207909ee3115493 /src/libs/zeroconf | |
| parent | 440725322abf0189c0cb28baddebe76bc26c5f05 (diff) | |
| download | qt-creator-41411165bac561d3cd93a793c6ae76dcb2937e12.tar.gz | |
Doc: use standard wording in \brief commands
QDoc does some magic with the \class and \namespaces
and \brief commands, so the following wording must be used:
"The xxx class yyy ..."
Change-Id: Id231f30e8464898b776888d5423523de404aae34
Reviewed-by: Eike Ziller <eike.ziller@digia.com>
Diffstat (limited to 'src/libs/zeroconf')
| -rw-r--r-- | src/libs/zeroconf/servicebrowser.cpp | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/src/libs/zeroconf/servicebrowser.cpp b/src/libs/zeroconf/servicebrowser.cpp index b1e8eebfb5..f41a3f3bbb 100644 --- a/src/libs/zeroconf/servicebrowser.cpp +++ b/src/libs/zeroconf/servicebrowser.cpp @@ -68,7 +68,8 @@ typedef long suseconds_t; /*! \namespace ZeroConf - \brief namespace for zeroconf (Bonjour/DNS-SD) functionality, currently mostly for browsing services. + \brief The ZeroConf namespace provides zeroconf (Bonjour/DNS-SD) + functionality, currently mostly for browsing services. */ namespace { // anonymous namespace for free functions @@ -220,9 +221,8 @@ int gQuickStop = 0; /*! \class ZeroConf::ErrorMessage - \brief class representing an error message + \brief The ErrorMessage class represents an error message. - very simple class representing an error message */ /// empty constructor (required by qRegisterMetaType) @@ -258,7 +258,7 @@ QDebug operator<<(QDebug dbg, const ErrorMessage &eMsg) /*! \class ZeroConf::Service - \brief class representing a zeroconf service + \brief The Service class represents a zeroconf service. Instances of this class are basically constant, but can be outdated. They are normally accessed through a Shared pointer. @@ -448,7 +448,8 @@ QDebug operator<<(QDebug dbg, const Service::ConstPtr &service){ /*! \class ZeroConf::ServiceBrowser - \brief class that browses (searches) for a given zeronconf service + \brief The ServiceBrowser class browses (searches) for a given zeronconf + service. The actual browsing starts only when startBrowsing() is called. If you want to receive all service changes connect before starting browsing. |