diff options
| author | Leena Miettinen <riitta-leena.miettinen@digia.com> | 2013-09-06 13:23:11 +0200 |
|---|---|---|
| committer | Leena Miettinen <riitta-leena.miettinen@digia.com> | 2013-09-09 12:55:00 +0200 |
| commit | efbecf21dbdbc803c4c016fdb90803edec82cf19 (patch) | |
| tree | 9a086a1ac450672774e04fde82efef95db23f71d /src/libs/utils/tcpportsgatherer.cpp | |
| parent | 5358ffe9036c09a4ee5d0135159064ec9a226037 (diff) | |
| download | qt-creator-efbecf21dbdbc803c4c016fdb90803edec82cf19.tar.gz | |
Doc: edit utils docs
Use \a for all attributes in function descriptions
to avoid QDoc errors. Do not use \param, because
it is not a valid QDoc command.
Do not use \returns as it does not exist.
Do not use \brief for functions. It is not obligatory, so
rather than add them for all functions, let's consistenly leave them out.
Fix typos, grammar and style issues, and punctuation.
Change-Id: Ib8f296f93976265bb93dbeab40c5b47156518122
Reviewed-by: hjk <hjk121@nokiamail.com>
Diffstat (limited to 'src/libs/utils/tcpportsgatherer.cpp')
| -rw-r--r-- | src/libs/utils/tcpportsgatherer.cpp | 5 |
1 files changed, 3 insertions, 2 deletions
diff --git a/src/libs/utils/tcpportsgatherer.cpp b/src/libs/utils/tcpportsgatherer.cpp index 0f56da91e6..a346b34548 100644 --- a/src/libs/utils/tcpportsgatherer.cpp +++ b/src/libs/utils/tcpportsgatherer.cpp @@ -250,7 +250,8 @@ void TcpPortsGathererPrivate::updateNetstat() \brief The TcpPortsGatherer class gathers the list of local TCP ports already in use. - Query the system for the list of local TCP ports already in use. This information can be used + Queries the system for the list of local TCP ports already in use. This + information can be used to select a port for use in a range. */ @@ -283,7 +284,7 @@ QList<int> TcpPortsGatherer::usedPorts() const } /*! - Select a port out of \a freePorts that is not yet used. + Selects a port out of \a freePorts that is not yet used. Returns the port, or -1 if no free port is available. */ |