]> git.meshlink.io Git - meshlink/blobdiff - src/meshlink++.h
Fix spelling errors.
[meshlink] / src / meshlink++.h
index 312b42c81aa8bbd5a7ee4e2a1353f1e86fc2bfed..37ca7e8b4d799281bcf0c86eeb0da1b60a3507af 100644 (file)
@@ -147,7 +147,7 @@ public:
         *  @param appname  The application name which will be used in the mesh.
         *  @param devclass The device class which will be used in the mesh.
         *
-        *  @return         This function will return a pointer to a meshlink::mesh if MeshLink has succesfully set up its configuration files, NULL otherwise.
+        *  @return         This function will return a pointer to a meshlink::mesh if MeshLink has successfully set up its configuration files, NULL otherwise.
         */
        bool open(const char *confbase, const char *name, const char *appname, dev_class_t devclass) {
                handle = meshlink_open(confbase, name, appname, devclass);
@@ -213,7 +213,7 @@ public:
                (void)message;
        }
 
-       /// This functions is called whenever another node attemps to open a channel to the local node.
+       /// This functions is called whenever another node attempts to open a channel to the local node.
        /**
         *  If the channel is accepted, the poll_callback will be set to channel_poll and can be
         *  changed using set_channel_poll_cb(). Likewise, the receive callback is set to
@@ -279,7 +279,7 @@ public:
        /** This function causes MeshLink to open network sockets, make outgoing connections, and
         *  create a new thread, which will handle all network I/O.
         *
-        *  @return         This function will return true if MeshLink has succesfully started its thread, false otherwise.
+        *  @return         This function will return true if MeshLink has successfully started its thread, false otherwise.
         */
        bool start() {
                meshlink_set_receive_cb(handle, &receive_trampoline);
@@ -507,7 +507,7 @@ public:
         *                       If the port is set to 0, then MeshLink will listen on a port
         *                       that is randomly assigned by the operating system every time open() is called.
         *
-        *  @return              This function returns true if the port was succesfully changed, false otherwise.
+        *  @return              This function returns true if the port was successfully changed, false otherwise.
         */
        bool set_port(int port) {
                return meshlink_set_port(handle, port);
@@ -543,7 +543,7 @@ public:
        /// Use an invitation to join a mesh.
        /** This function allows the local node to join an existing mesh using an invitation URL generated by another node.
         *  An invitation can only be used if the local node has never connected to other nodes before.
-        *  After a succesfully accepted invitation, the name of the local node may have changed.
+        *  After a successfully accepted invitation, the name of the local node may have changed.
         *
         *  This function may only be called on a mesh that has not been started yet and which is not already part of an existing mesh.
         *
@@ -792,7 +792,7 @@ static inline const char *strerror(errno_t err = meshlink_errno) {
  *  @param confbase The directory in which MeshLink stores its configuration files.
  *                  After the function returns, the application is free to overwrite or free @a confbase @a.
  *
- *  @return         This function will return true if the MeshLink instance was succesfully destroyed, false otherwise.
+ *  @return         This function will return true if the MeshLink instance was successfully destroyed, false otherwise.
  */
 static inline bool destroy(const char *confbase) {
        return meshlink_destroy(confbase);