Add Doxygen support to the build system.

[meshlink] / src / meshlink++.h

diff --git a/src/meshlink++.h b/src/meshlink++.h
index 93020661b922b21b1c1b43dbc2e7dd105f65138d..bca39fd32332a2e3497e08a36f56c39056e49173 100644 (file)
--- a/src/meshlink++.h
+++ b/src/meshlink++.h
@@ -619,6 +619,18 @@ public:
                meshlink_set_invitation_timeout(handle, timeout);
        }
 
+       /// Set the scheduling granularity of the application
+       /** This should be set to the effective scheduling granularity for the application.
+        *  This depends on the scheduling granularity of the operating system, the application's
+        *  process priority and whether it is running as realtime or not.
+        *  The default value is 10000 (10 milliseconds).
+        *
+        *  @param granularity  The scheduling granularity of the application in microseconds.
+        */
+       void set_granularity(long granularity) {
+               meshlink_set_scheduling_granularity(handle, granularity);
+       }
+
        /// Invite another node into the mesh.
        /** This function generates an invitation that can be used by another node to join the same mesh as the local node.
         *  The generated invitation is a string containing a URL.
@@ -752,7 +764,7 @@ public:
         *  This is useful if new nodes are blacklisted by default.
         *
         *  \memberof meshlink_node
-        *  @param node         A pointer to a struct meshlink_node describing the node to be whitelisted.
+        *  @param name         The name of the node to whitelist.
         *
         *  @return             This function returns true if the node has been whitelisted, false otherwise.
         */
@@ -803,7 +815,7 @@ public:
        /** This sets the timeout after which unresponsive channels will be reported as closed.
         *  The timeout is set for all current and future channels to the given node.
         *
-        *  @param channel      A handle for the channel.
+        *  @param node         The node to set the channel timeout for.
         *  @param timeout      The timeout in seconds after which unresponsive channels will be reported as closed.
         *                      The default is 60 seconds.
         */