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/command_table.hpp b/command_table.hpp
index 85d7c3e..62738c8 100644
--- a/command_table.hpp
+++ b/command_table.hpp
@@ -27,7 +27,7 @@
uint8_t cmd;
} __attribute__((packed));
-/*
+/**
* CommandFunctor is the functor register for commands defined in
* phosphor-net-ipmid. This would take the request part of the command as a
* vector and a reference to the message handler. The response part of the
@@ -36,7 +36,7 @@
using CommandFunctor = std::function<std::vector<uint8_t>(
const std::vector<uint8_t>&, const message::Handler&)>;
-/*
+/**
* @struct CmdDetails
*
* Command details is used to register commands supported in phosphor-net-ipmid.
@@ -49,7 +49,7 @@
bool sessionless;
};
-/*
+/**
* @enum NetFns
*
* A field that identifies the functional class of the message. The Network
@@ -92,7 +92,7 @@
OEM_RESP = (0x2F << 10),
};
-/*
+/**
* @class Entry
*
* This is the base class for registering IPMI commands. There are two ways of
@@ -148,7 +148,7 @@
session::Privilege privilege;
};
-/*
+/**
* @class NetIpmidEntry
*
* NetIpmidEntry is used to register commands that are consumed only in
@@ -197,7 +197,7 @@
bool sessionless;
};
-/*
+/**
* @class ProviderIpmidEntry
*
* ProviderIpmidEntry is used to register commands to the Command Table, that
@@ -237,7 +237,7 @@
ipmid_callback_t functor;
};
-/*
+/**
* @class Table
*
* Table keeps the IPMI command entries as a sorted associative container with