libt2n: (gerd) doxygenize

[libt2n] / src / connection.cpp

diff --git a/src/connection.cpp b/src/connection.cpp
index 459194d..a1b22a7 100644 (file)
--- a/src/connection.cpp
+++ b/src/connection.cpp
@@ -43,6 +43,11 @@ connection::packet_size_indicator connection::bytes_available()
     return psize;
 }
 
+/** @brief read a complete data packet from the buffer. The packet is removed from the
+            connection buffer.
+    @param[out] data the data package
+    @retval true if packet found
+*/
 bool connection::get_packet(std::string& data)
 {
     packet_size_indicator psize;
@@ -57,6 +62,7 @@ bool connection::get_packet(std::string& data)
         return false;
 }
 
+/// send a blob to the peer
 void connection::write(const std::string& data)
 {
     // prepend packet size to data