Correct doxygen syntax in phosphor-net-ipmid
Resolves openbmc/openbmc#1147
Change-Id: I57ab1b09ec1bf308cc3d97cd30b2d18564beb38b
Signed-off-by: Tom Joseph <tomjoseph@in.ibm.com>
diff --git a/sessions_manager.hpp b/sessions_manager.hpp
index 792516b..1d842de 100644
--- a/sessions_manager.hpp
+++ b/sessions_manager.hpp
@@ -19,7 +19,7 @@
constexpr size_t MAX_SESSIONLESS_COUNT = 1;
constexpr size_t MAX_SESSION_COUNT = 5;
-/*
+/**
* @class Manager
*
* Manager class acts a manager for the IPMI sessions and provides interfaces
@@ -41,7 +41,7 @@
Manager(Manager&&) = default;
Manager& operator=(Manager&&) = default;
- /*
+ /**
* @brief Start an IPMI session
*
* @param[in] remoteConsoleSessID - Remote Console Session ID mentioned
@@ -59,7 +59,7 @@
cipher::integrity::Algorithms intAlgo,
cipher::crypt::Algorithms cryptAlgo);
- /*
+ /**
* @brief Stop IPMI Session
*
* @param[in] bmcSessionID - BMC Session ID
@@ -69,7 +69,7 @@
*/
bool stopSession(SessionID bmcSessionID);
- /*
+ /**
* @brief Get Session Handle
*
* @param[in] sessionID - Session ID
@@ -85,13 +85,13 @@
private:
- /*
+ /**
* @brief Session Manager keeps the session objects as a sorted
* associative container with Session ID as the unique key
*/
SessionMap sessionsMap;
- /*
+ /**
* @brief Clean Session Stale Entries
*
* Removes the inactive sessions entries from the Session Map