From 38a67ae0bbd398b757de7860086d929456c89c73 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Nicol=C3=A1s=20Ortega=20Froysa?= Date: Fri, 18 Aug 2017 18:19:19 -0500 Subject: [PATCH] Added documentation for Node class. --- include/neocomm/Node.hpp | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/include/neocomm/Node.hpp b/include/neocomm/Node.hpp index 5d53f16..5e7dda8 100644 --- a/include/neocomm/Node.hpp +++ b/include/neocomm/Node.hpp @@ -26,11 +26,28 @@ #endif namespace neocomm { + /** + * @brief Network node. + */ class Node { public: + /** + * @brief Initialize local node. + */ Node(); virtual ~Node(); + + /** + * @brief Bind the node to a port. + * + * @param port Local port to bind to. + */ void bind(const short &port = DEFAULT_PORT); + /** + * @brief Retrieve the current status of the connection. + * + * @return String describing connection status. + */ const std::string getStatus() const; private: dht::DhtRunner node;