Skip to content

Commit

Permalink
fix for doxygen documentation
Browse files Browse the repository at this point in the history
Doxygen keywords must be backslashed, not slashed.

Change-Id: I625e1241981c46da2d5a17da4daf4b9a571f3a35
Reviewed-by: Olivier Soldano <olivier.soldano@savoirfairelinux.com>
  • Loading branch information
Guillaume Roguez authored and Olivier SOLDANO committed Jan 5, 2018
1 parent 755347d commit 49c4bb1
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 10 deletions.
2 changes: 1 addition & 1 deletion src/call.h
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
2 changes: 1 addition & 1 deletion src/channel.h
Original file line number Diff line number Diff line change
Expand Up @@ -191,7 +191,7 @@ class Channel<T> : public detail::_ChannelBase<T> {
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) {
Expand Down
16 changes: 8 additions & 8 deletions src/turn_transport.h
Original file line number Diff line number Diff line change
Expand Up @@ -100,15 +100,15 @@ class TurnTransport

/// 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);

Expand All @@ -118,12 +118,12 @@ class TurnTransport

/// 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);

Expand Down

0 comments on commit 49c4bb1

Please sign in to comment.