commit 9d7f8fe0b6141d6998d34d793d019212531b3bde
author Alexander Afanasyev <alexander.afanasyev@ucla.edu> Fri Aug 05 11:28:06 2016 -0700
committer Alexander Afanasyev <alexander.afanasyev@ucla.edu> Fri Aug 05 11:28:06 2016 -0700
tree 68ff03eb44d11d5f0cb86919108c307ef1806a7b
parent c1264c85a8f618315bb8d6dd26c1f13140425339

build+docs: Add doxygen generation target

This commit also fixes few documentation errors

Change-Id: Ie34eaf167b7e423c82c1e453fbd0bbf2ac2c805c

src/consumer.hpp

diff --git a/src/consumer.hpp b/src/consumer.hpp
index 5da849b..40a5c11 100644
--- a/src/consumer.hpp
+++ b/src/consumer.hpp
@@ -58,6 +58,7 @@
   /**
    * @brief Send out the Interest packet to fetch content packet with @p dataName.
    *
+   * @param dataName name of the data packet to fetch
    * @param consumptionCallBack The callback when requested data is decrypted
    * @param errorCallBack The callback when error happens in consumption
    */

src/group-manager.hpp

diff --git a/src/group-manager.hpp b/src/group-manager.hpp
index f2d439d..e4674df 100644
--- a/src/group-manager.hpp
+++ b/src/group-manager.hpp
@@ -47,7 +47,7 @@
   /**
    * @brief Create group manager
    *
-   * The namespace of group manager is /<prefix>/read/<dataType>/
+   * The namespace of group manager is /[prefix]/read/[dataType]/
    * The group management information (including user cert, schedule) is stored in a database
    * at @p dbPath.
    * The group key will be an RSA key with @p paramLength bits.

src/interval.hpp

diff --git a/src/interval.hpp b/src/interval.hpp
index 5764454..e2cd23f 100644
--- a/src/interval.hpp
+++ b/src/interval.hpp
@@ -49,7 +49,7 @@
   /**
    * @brief Construction to create an object
    *
-   * @parameter isValid If isValid is true, the created interval is an empty interval
+   * @param isValid If isValid is true, the created interval is an empty interval
    */
   explicit
   Interval(bool isValid = false);
@@ -61,7 +61,7 @@
    * @brief Check if the timestamp tp is in the interval
    * @pre this->isValid() == true
    *
-   * @parameter tp A timestamp
+   * @param tp A timestamp
    */
   bool
   covers(const TimeStamp& tp) const;

src/repetitive-interval.hpp

diff --git a/src/repetitive-interval.hpp b/src/repetitive-interval.hpp
index 1e8127f..6ac5e68 100644
--- a/src/repetitive-interval.hpp
+++ b/src/repetitive-interval.hpp
@@ -72,10 +72,10 @@
   /**
    * @brief Get get an interval that @p tp falls in
    *
-   * @parameter tp A timestamp
+   * @param tp A timestamp
    *
    * @return bool If the repetitive interval covers the @p tp, return true, otherwise false
-   * @return Interval Return the interval which @tp falls in
+   * @return Interval Return the interval which @p tp falls in
    */
   std::tuple<bool, Interval>
   getInterval(const TimeStamp& tp) const;
@@ -83,7 +83,7 @@
   /**
    * @brief To store in std::set, class have to implement operator <
    *
-   * @parameter interval Interval which will be compared with
+   * @param interval Interval which will be compared with
    */
   bool
   operator<(const RepetitiveInterval& interval) const;