Fix Doxygen warnings

[Bug]           Doxygen warnings during documentation generation.
[Cause]         Some docblocks were incomplete.
[Solution]      Fix warnings.
[Verification]  Build, run tests, ./generate_documentation.sh. During doc
                generation there will be warnings related to
                command-line-interface.hpp stating "no matching file memeber".
                This is a Doxygen bug and the only possible fix is to
                replace Args typedef with std::vector<std::string>.

Change-Id: I1523dc83a5f5e9902e5983ac5b95497d61f71cfc

diff --git a/client/vasum-client.h b/client/vasum-client.h
index 4544893..cd38aee 100644 (file)
--- a/client/vasum-client.h
+++ b/client/vasum-client.h
@@ -743,8 +743,8 @@ VsmStatus vsm_netdev_down(VsmClient client,
  *
  * @param[in] client vasum-server's client
  * @param[in] zone zone name
- * @param[in] zoneDev in host network device id
- * @param[in] hostDev in zone network device id
+ * @param[in] zoneDev  Device ID in Zone network
+ * @param[in] hostDev  Device ID in Host network
  * @return status of this function call
  */
 VsmStatus vsm_create_netdev_veth(VsmClient client,
@@ -752,13 +752,16 @@ VsmStatus vsm_create_netdev_veth(VsmClient client,
                                  const char* zoneDev,
                                  const char* hostDev);
 /**
- * Create macvlab in zone
+ * Create macvlan in zone
  *
- * @param[in] client vasum-server's client
- * @param[in] zone zone name
- * @param[in] zoneDev in host network device id
- * @param[in] hostDev in zone network device id
+ * @param[in] client   vasum-server's client
+ * @param[in] zone     Zone name
+ * @param[in] zoneDev  Device ID in Zone network
+ * @param[in] hostDev  Device ID in Host network
+ * @param[in] mode     Mode with which macvlan will be created.
  * @return status of this function call
+ *
+ * @see macvlan_mode
  */
 VsmStatus vsm_create_netdev_macvlan(VsmClient client,
                                     const char* zone,
@@ -866,7 +869,7 @@ VsmStatus vsm_declare_link(VsmClient client,
  * Get all declarations
  *
  * Gets all declarations of resourcies
- * (@see ::vsm_declare_link, @see ::vsm_declare_mount, @see ::vsm_declare_linki)
+ * (@see ::vsm_declare_link, @see ::vsm_declare_mount, @see ::vsm_declare_file)
  *
  * @param[in] client vasum-server's client
  * @param[in] zone zone id

diff --git a/common/utils/latch.hpp b/common/utils/latch.hpp
index ad48475..4c46daf 100644 (file)
--- a/common/utils/latch.hpp
+++ b/common/utils/latch.hpp
@@ -61,14 +61,14 @@ public:
     bool wait(const unsigned int timeoutMs);
 
     /**
-     * Waits for @ref n occurrences of event.
+     * Waits for @n occurrences of event.
      *
-     * @param n  number of occurrences to wait for
+     * @param n number of occurrences to wait for
      */
     void waitForN(const unsigned int n);
 
     /**
-     * Waits for @ref n occurrences of event with timeout.
+     * Waits for @n occurrences of event with timeout.
      *
      * @param n          number of occurrences to wait for
      * @param timeoutMs  timeout in ms to wait for

diff --git a/server/fake-power-manager-dbus-definitions.hpp b/server/fake-power-manager-dbus-definitions.hpp
index 0abeb73..a9931aa 100644 (file)
--- a/server/fake-power-manager-dbus-definitions.hpp
+++ b/server/fake-power-manager-dbus-definitions.hpp
@@ -17,7 +17,7 @@
  */
 
 /**
- * @file    fake-power-manager-dbus-definitions.h
+ * @file
  * @author  Lukasz Kostyra (l.kostyra@samsung.com)
  * @brief   Declaration of fake dbus definitions from power-manager. Made only to test API in
  *          ZoneConnection.