docs: Fix doxygen errors
Change-Id: I90cbba89e98bf905984ce02c7129504b70f6cdda
diff --git a/src/clients/query.hpp b/src/clients/query.hpp
index 7b6de33..d1bba0b 100644
--- a/src/clients/query.hpp
+++ b/src/clients/query.hpp
@@ -29,8 +29,11 @@
namespace ndns {
/**
- * @brief NDNS Query abstraction. Query is an Interest whose name follows the format:
- * <hint> /xF0. <zone> [<KEY>|<NDNS>|<NDNS-R>] <rrLabel> <rrType>
+ * @brief NDNS Query abstraction
+ *
+ * Query is an Interest whose name follows the format:
+ *
+ * <hint> /xF0. <zone> [<KEY>|<NDNS>|<NDNS-R>] <rrLabel> <rrType>
*/
class Query : noncopyable
{
@@ -47,8 +50,11 @@
/**
* @brief extract the query information (rrLabel, rrType) from a Interest
- * @param[in] interest The Interest to parse; the Interest must have correct hint and zone,
- * otherwise it's undefined behavior
+ *
+ * @param hint Forwarding hint
+ * @param zone NDNS zone
+ * @param interest The Interest to parse; the Interest must have correct hint and zone,
+ * otherwise it's undefined behavior
*/
bool
fromInterest(const Name& hint, const Name& zone, const Interest& interest);
diff --git a/src/clients/response.hpp b/src/clients/response.hpp
index 240659b..62e88ed 100644
--- a/src/clients/response.hpp
+++ b/src/clients/response.hpp
@@ -56,10 +56,13 @@
/**
* @brief fill the attributes from Data packet.
- * @param[in] data Data.getName() must the same hint (if has) and zone as its prefix,
- * otherwise it's undefined behavior
+ *
+ * @param hint Forwarding hint
+ * @param zone NDNS zone name
+ * @param data Data.getName() must the same hint (if has) and zone as its prefix,
+ * otherwise it's undefined behavior
* @return false if Data.getName() does not follow the structure of NDNS Response without
- * changing any attributes, otherwise return true and fill the attributes
+ * changing any attributes, otherwise return true and fill the attributes
*/
bool
fromData(const Name& hint, const Name& zone, const Data& data);
@@ -72,8 +75,9 @@
/**
* @brief add Block which contains string information and its tlv type is ndns::tlv::RrData
- * Response is service level information, the encoding level abstraction,
- * i.e., Block is not very convenient.
+ *
+ * @return Response that is service level information, the encoding level abstraction,
+ * i.e., Block is not very convenient.
*/
Response&
addRr(const std::string& rr);