From 49c4bb186e493115b64caa9b385016b2100b1996 Mon Sep 17 00:00:00 2001
From: Guillaume Roguez <guillaume.roguez@savoirfairelinux.com>
Date: Wed, 3 Jan 2018 15:47:16 -0500
Subject: [PATCH] fix for doxygen documentation
Doxygen keywords must be backslashed, not slashed.
Change-Id: I625e1241981c46da2d5a17da4daf4b9a571f3a35
Reviewed-by: Olivier Soldano <olivier.soldano@savoirfairelinux.com>
---
src/call.h | 2 +-
src/channel.h | 2 +-
src/turn_transport.h | 16 ++++++++--------
3 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/src/call.h b/src/call.h
index 398ef83c2b..d4c9c4148a 100644
--- a/src/call.h
+++ b/src/call.h
@@ -310,7 +310,7 @@ class Call : public Recordable, public std::enable_shared_from_this<Call> {
* Update call details after creation.
* @param details to update
*
- * /note No warranty to update any details, only some details can be modified.
+ * \note No warranty to update any details, only some details can be modified.
* See the implementation for more ... details :-).
*/
void updateDetails(const std::map<std::string, std::string>& details);
diff --git a/src/channel.h b/src/channel.h
index a566473428..addde5252f 100644
--- a/src/channel.h
+++ b/src/channel.h
@@ -191,7 +191,7 @@ public:
cv_.notify_one();
}
- /// /note This method exists only for unlimited channel
+ /// \note This method exists only for unlimited channel
void send(const T* data, std::size_t len) {
std::lock_guard<std::mutex> lk {mutex_};
while (len > 0) {
diff --git a/src/turn_transport.h b/src/turn_transport.h
index f884af7a98..6f2d87984c 100644
--- a/src/turn_transport.h
+++ b/src/turn_transport.h
@@ -100,15 +100,15 @@ public:
/// Collect pending data from a given peer.
///
- /// Data are read from given /a peer incoming buffer until EOF or /a data size() is reached.
- /// /a data is resized with exact number of characters read.
- /// If /a peer is not connected this function raise an exception.
- /// If /a peer exists but no data are available this method blocks until TURN deconnection
+ /// Data are read from given \a peer incoming buffer until EOF or \a data size() is reached.
+ /// \a data is resized with exact number of characters read.
+ /// If \a peer is not connected this function raise an exception.
+ /// If \a peer exists but no data are available this method blocks until TURN deconnection
/// or at first incoming character.
///
/// \param [in] peer target peer address where data are read
/// \param [in,out] pre-dimensionned character vector to write incoming data
- /// \exception std::out_of_range /a peer is not connected yet
+ /// \exception std::out_of_range \a peer is not connected yet
///
void recvfrom(const IpAddr& peer, std::vector<char>& data);
@@ -118,12 +118,12 @@ public:
/// Send data to given peer through the TURN tunnel.
///
- /// This method blocks until all given characters in /a data are sent to the given /a peer.
- /// If /a peer is not connected this function raise an exception.
+ /// This method blocks until all given characters in \a data are sent to the given \a peer.
+ /// If \a peer is not connected this function raise an exception.
///
/// \param [in] peer target peer address where data are read
/// \param [in,out] pre-dimensionned character vector to write incoming data
- /// \exception std::out_of_range /a peer is not connected yet
+ /// \exception std::out_of_range \a peer is not connected yet
///
bool sendto(const IpAddr& peer, const std::vector<char>& data);
--
GitLab