fix spelling errors

Change-Id: Ifbc5f3792a7019dcfa8249eb30afe2a64cbeb57c
Reviewed-by: Sebastien Blin <sebastien.blin@savoirfairelinux.com>

MSVC/config.h

@@ -203,7 +203,7 @@ STACK_DIRECTION = 0 => direction of growth unknown */
 /* Version number of package */
 #define VERSION "2.3.0"
 
-// UWP compatability
+// UWP compatibility
 #define PROGSHAREDIR ""
 
 /* Define to limit the scope of <windows.h>. */

bin/dbus/cx.ring.Ring.CallManager.xml

@@ -178,7 +178,7 @@
             </tp:docstring>
             <arg type="s" name="transferID" direction="in">
               <tp:docstring>
-                The callID of the call to be transfered.
+                The callID of the call to be transferred.
               </tp:docstring>
             </arg>
             <arg type="s" name="targetID" direction="in">
@@ -271,15 +271,15 @@
             <tp:docstring>
                 Detach local participant from the conference.
                 Remote participants are placed in hold.
-                The signal <tp:member-ref>conferenceChanged</tp:member-ref> is emited.
+                The signal <tp:member-ref>conferenceChanged</tp:member-ref> is emitted.
             </tp:docstring>
             <arg type="b" name="detachSucceeded" direction="out"/>
         </method>
 
         <method name="detachParticipant" tp:name-for-bindings="detachParticipant">
             <tp:added version="0.9.7"/>
             <tp:docstring>
-              Detach the given call from the conference. If only one participant is left, the conference is deleted and the signal <tp:member-ref>conferenceRemoved</tp:member-ref> is emited.
+              Detach the given call from the conference. If only one participant is left, the conference is deleted and the signal <tp:member-ref>conferenceRemoved</tp:member-ref> is emitted.
             </tp:docstring>
             <arg type="s" name="callID" direction="in">
               <tp:docstring>
@@ -342,7 +342,7 @@
         <method name="getConferenceId" tp:name-for-bindings="getConferenceId">
             <tp:added version="1.1.0"/>
             <tp:docstring>
-                If thsi call participate to a conference, return the conference id.
+                If this call participate to a conference, return the conference id.
                 Return an empty string elsewhere.
             </tp:docstring>
             <arg type="s" name="callID" direction="in">
@@ -415,7 +415,7 @@
 
         <signal name="recordPlaybackFilepath" tp:name-for-bindings="recordPlaybackFilepath">
             <tp:docstring>
-              Once after starting recording for the first time, this signal is emited to
+              Once after starting recording for the first time, this signal is emitted to
               provide the recorded file path to client application.
             </tp:docstring>
             <arg type="s" name="callID" />
@@ -650,7 +650,7 @@
         <signal name="conferenceCreated" tp:name-for-bindings="conferenceCreated">
             <tp:added version="0.9.7"/>
             <tp:docstring>
-              Emited when a new conference is created. Ring-client is reponsible for storing the confID and call <tp:member-ref>getParticipantList</tp:member-ref> to update the display.
+              Emitted when a new conference is created. Ring-client is responsible for storing the confID and call <tp:member-ref>getParticipantList</tp:member-ref> to update the display.
             </tp:docstring>
             <arg type="s" name="confID">
               <tp:docstring>
@@ -662,7 +662,7 @@
         <signal name="conferenceRemoved" tp:name-for-bindings="conferenceRemoved">
             <tp:added version="0.9.7"/>
             <tp:docstring>
-              Emited when a new conference is remove. Ring-client should have kept a list of current participant in order to display modification.
+              Emitted when a new conference is remove. Ring-client should have kept a list of current participant in order to display modification.
             </tp:docstring>
             <arg type="s" name="confID">
               <tp:docstring>
@@ -727,7 +727,7 @@
         <signal name="transferSucceeded" tp:name-for-bindings="transferSucceeded">
             <tp:docstring>
               <p>Transfer has been successfully
-              processed. Client should remove transfered
+              processed. Client should remove transferred
               call from call list as it is no longer
               accessible in Ring-daemon (dring).</p>
             </tp:docstring>

bin/dbus/cx.ring.Ring.ConfigurationManager.xml

@@ -32,7 +32,7 @@
                         <li>CONFIG_ACCOUNT_ENABLE:    True or False (Default: True)</li>
                         <li>CONFIG_ACCOUNT_RESOLVE_ONCE</li>
                         <li>CONFIG_ACCOUNT_TYPE: SIP or RING</li>
-                        <li>HOSTNAME: The IP adress or hostname of the registrar</li>
+                        <li>HOSTNAME: The IP address or hostname of the registrar</li>
                         <li>USERNAME: The username (or extension) of the account</li>
                         <li>PASSWORD: The password associated to the account</li>
                         <li>REALM</li>
@@ -1183,7 +1183,7 @@
            </arg>
            <arg type="b" name="success" direction="out">
                <tp:docstring>
-                   <p>True if the certificate state was succesfully set.</p>
+                   <p>True if the certificate state was successfully set.</p>
                </tp:docstring>
            </arg>
        </method>

bin/restcpp/restclient.cpp

@@ -103,7 +103,7 @@ RestClient::initLib(int flags)
 
     // Configuration event handlers
 
-    // This is a short example of a callbakc using a lambda. In this case, this displays the incomming messages
+    // This is a short example of a callback using a lambda. In this case, this displays the incoming messages
     const std::map<std::string, SharedCallback> configEvHandlers = {
         exportable_callback<ConfigurationSignal::IncomingAccountMessage>([]
             (const std::string& accountID, const std::string& from, const std::map<std::string, std::string>& payloads){
@@ -146,7 +146,7 @@ RestClient::initResources()
     // This is the function that initiates the resources.
     // Each resources is defined by a route and a void function with a shared pointer to the session as argument
 
-    // In this case, here's an example of the default route. It will list all the managers availables
+    // In this case, here's an example of the default route. It will list all the managers available
     auto default_res = std::make_shared<restbed::Resource>();
     default_res->set_path("/");
     default_res->set_method_handler("GET", [](const std::shared_ptr<restbed::Session> session){

src/account_schema.h

@@ -24,7 +24,7 @@
 
 /**
  * @file account_schema.h
- * @brief Account specfic keys/constants that must be shared in daemon and clients.
+ * @brief Account specific keys/constants that must be shared in daemon and clients.
  */
 
 namespace ring { namespace Conf {

src/dring/configurationmanager_interface.h

@@ -205,7 +205,7 @@ void enableProxyClient(const std::string& accountID, bool enable);
 void setPushNotificationToken(const std::string& pushDeviceToken);
 
 /**
- * To be called by clients with relevent data when a push notification is received.
+ * To be called by clients with relevant data when a push notification is received.
  */
 void pushNotificationReceived(const std::string& from, const std::map<std::string, std::string>& data);
 
@@ -313,7 +313,7 @@ struct ConfigurationSignal {
                 using cb_type = void(const std::string& /*accountId*/, const std::string& /*device*/, int /*status*/);
         };
         /**
-         * These are special getters for Android and UWP, so the daemon can retreive
+         * These are special getters for Android and UWP, so the daemon can retrieve
          * information only accessible through their respective platform APIs
          */
 #if defined(__ANDROID__) || (defined(TARGET_OS_IOS) && TARGET_OS_IOS)

src/dring/datatransfer_interface.h

@@ -73,7 +73,7 @@ struct DataTransferInfo
     std::string peer; ///< Identifier of the remote peer (in the semantic of the associated account)
     std::string displayName; ///< Human oriented transfer name
     std::string path; ///< associated local file path if supported (empty, if not)
-    std::string mimetype; ///< MimeType of transfered data (https://www.iana.org/assignments/media-types/media-types.xhtml)
+    std::string mimetype; ///< MimeType of transferred data (https://www.iana.org/assignments/media-types/media-types.xhtml)
 };
 
 std::vector<DataTransferId> dataTransferList() noexcept;
@@ -93,7 +93,7 @@ std::vector<DataTransferId> dataTransferList() noexcept;
 ///
 /// Other fields are not used, but you must keep the default assigned value for compatibility.
 ///
-/// \param info a DataTransferInfo structure filled with information usefull for a file transfer.
+/// \param info a DataTransferInfo structure filled with information useful for a file transfer.
 /// \param[out] id data transfer identifiant if function succeed, usable with other APIs. Undefined value in case of error.
 ///
 /// \return DataTransferError::success if file is accepted for transfer, any other value in case of errors
@@ -114,7 +114,7 @@ DataTransferError sendFile(const DataTransferInfo& info, DataTransferId& id) noe
 /// \param id data transfer identification value as given by a DataTransferEvent signal.
 /// \param file_path file path going to be open in binary write mode to put incoming data.
 /// \param offset used to indicate the remote side about the number of bytes already received in
-/// a previous transfer session, usefull in transfer continuation mode.
+/// a previous transfer session, useful in transfer continuation mode.
 ///
 /// \return DataTransferError::invalid_argument if id is unknown.
 /// \note unknown \a id results to a no-op call.

src/dring/dring.h

@@ -52,7 +52,7 @@ bool init(enum InitFlag flags) noexcept;
 
 /**
  * Start asynchronously daemon created by init().
- * @returns true if daemon started successfuly
+ * @returns true if daemon started successfully
  */
 bool start(const std::string& config_file={}) noexcept;
 
@@ -81,7 +81,7 @@ void pollEvents() noexcept;
  * to keep compatibility over releases we don't let user directly provides
  * his callbacks as it or through a structure.
  * This way brings ABI violation if we need to change the order
- * and/or the existance of any callback type.
+ * and/or the existence of any callback type.
  * Thus the user have to pass them using following template classes
  * and functions, that wraps user-callback in a generic and ABI-compatible way.
  */

src/fileutils.h

@@ -59,7 +59,7 @@ namespace ring { namespace fileutils {
     std::string get_cache_dir();
 
     /**
-     * Check directory existance and create it with given mode if it doesn't.
+     * Check directory existence and create it with given mode if it doesn't.
      * @param path to check, relative or absolute
      * @param dir last directory creation mode
      * @param parents default mode for all created directories except the last

src/generic_io.h

@@ -45,7 +45,7 @@ class GenericSocket
     using RecvCb = std::function<ssize_t(const ValueType* buf, std::size_t len)>;
 
     /// Close established connection
-    /// \note Terminate oustanding blocking read operations with an empty error code, but a 0 read size.
+    /// \note Terminate outstanding blocking read operations with an empty error code, but a 0 read size.
     virtual void shutdown() {}
 
     /// Set Rx callback

src/ice_transport.h

@@ -88,7 +88,7 @@ class IceTransport {
     bool isInitiator() const;
 
     /**
-     * Start tranport negociation between local candidates and given remote
+     * Start tranport negotiation between local candidates and given remote
      * to find the right candidate pair.
      * This function doesn't block, the callback on_negodone_cb will be called
      * with the negotiation result when operation is really done.

src/manager.cpp

@@ -301,7 +301,7 @@ struct Manager::ManagerPimpl
 
     std::atomic_bool autoAnswer_ {false};
 
-    /** Application wide tone controler */
+    /** Application wide tone controller */
     ToneControl toneCtrl_;
 
     /** Current Call ID */
@@ -2020,7 +2020,7 @@ Manager::peerAnsweredCall(Call& call)
     const auto call_id = call.getCallId();
     RING_DBG("[call:%s] Peer answered", call_id.c_str());
 
-    // The if statement is usefull only if we sent two calls at the same time.
+    // The if statement is useful only if we sent two calls at the same time.
     if (isCurrentCall(call))
         stopTone();
 

src/manager.h

@@ -185,7 +185,7 @@ class Manager {
 
         /**
          * Attended transfer
-         * @param The call id to be transfered
+         * @param The call id to be transferred
          * @param The target
          */
         bool attendedTransfer(const std::string& transferID, const std::string& targetID);
@@ -233,7 +233,7 @@ class Manager {
         bool unHoldConference(const std::string& conference_id);
 
         /**
-         * Test if this id is a conference (usefull to test current call)
+         * Test if this id is a conference (useful to test current call)
          * @param the call id
          */
         bool isConference(const std::string& call_id) const;
@@ -690,7 +690,7 @@ class Manager {
 
         /**
          * @return true is there is one or many incoming call waiting
-         * new call, not anwsered or refused
+         * new call, not answered or refused
          */
         bool incomingCallsWaiting();
 

src/media/audio/audiobuffer.h

@@ -245,31 +245,31 @@ class AudioBuffer {
          * Convert fixed-point channel to float and write in the out buffer (Float 32-bits).
          * The out buffer must be at least of size capacity()*sizeof(float) bytes.
          *
-         * @returns Number of samples writen.
+         * @returns Number of samples written.
          */
         size_t channelToFloat(float* out, const int& channel) const;
 
         /**
          * Write interleaved multichannel data to the out buffer (fixed-point 16-bits).
          * The out buffer must be at least of size capacity()*sizeof(AudioSample) bytes.
          *
-         * @returns Number of samples writen.
+         * @returns Number of samples written.
          */
         size_t interleave(AudioSample* out) const;
 
         /**
          * Write null data (silence) to the out buffer (fixed-point 16-bits).
          * The out buffer must be at least of size capacity()*sizeof(AudioSample) bytes.
          *
-         * @returns Number of samples writen.
+         * @returns Number of samples written.
          */
         size_t fillWithZero(AudioSample* out) const;
 
         /**
          * Write interleaved multichannel data to the out buffer (fixed-point 16-bits).
          * The out buffer is resized to hold the full content of this buffer.
          *
-         * @returns Number of samples writen.
+         * @returns Number of samples written.
          */
         size_t interleave(std::vector<AudioSample>& out) const;
 
@@ -282,7 +282,7 @@ class AudioBuffer {
          * Write interleaved multichannel data to the out buffer, while samples are converted to float.
          * The out buffer must be at least of size capacity()*sizeof(float) bytes.
          *
-         * @returns Number of samples writen.
+         * @returns Number of samples written.
          */
         size_t interleaveFloat(float* out) const;
 

src/media/audio/audiorecord.h

@@ -54,7 +54,7 @@ class AudioRecord {
 
         /**
          * Check if no other file is opened, then create a new one
-         * @param filename A string containing teh file (with/without extension)
+         * @param filename A string containing the file (with/without extension)
          * @param type     The sound file format (FILE_RAW, FILE_WAVE)
          * @param format   Internal sound format (INT16 / INT32)
          * @return bool    True if file was opened

src/media/audio/opensl/audio_player.cpp

@@ -27,7 +27,7 @@ namespace opensl {
 
 /*
  * Called by OpenSL SimpleBufferQueue for every audio buffer played
- * directly pass thru to our handler.
+ * directly pass through to our handler.
  * The regularity of this callback from openSL/Android System affects
  * playback continuity. If it does not callback in the regular time
  * slot, you are under big pressure for audio processing[here we do

src/media/audio/ringbuffer.h

@@ -145,7 +145,7 @@ class RingBuffer {
         NON_COPYABLE(RingBuffer);
 
         /**
-         * Return the smalest readoffset. Usefull to evaluate if ringbuffer is full
+         * Return the smalest readoffset. Useful to evaluate if ringbuffer is full
          */
         size_t getSmallestReadOffset() const;
 

src/media/audio/ringbufferpool.h

@@ -57,7 +57,7 @@ class RingBufferPool {
         void setInternalAudioFormat(AudioFormat format);
 
         /**
-         * Bind together two audio streams so taht a client will be able
+         * Bind together two audio streams so that a client will be able
          * to put and get data specifying its callid only.
          */
         void bindCallID(const std::string& call_id1,
@@ -104,7 +104,7 @@ class RingBufferPool {
         /**
          * Create a new ringbuffer with a default readoffset.
          * This class keeps a weak reference on returned pointer,
-         * so the caller is responsible of the refered instance.
+         * so the caller is responsible of the referred instance.
          */
         std::shared_ptr<RingBuffer> createRingBuffer(const std::string& id);
 

src/media/audio/tonecontrol.h

@@ -32,7 +32,7 @@ namespace ring {
  * ToneControl is a class to handle application wide business logic
  * to control audio tones played at various application events.
  * Having an application wide instance gives a way to handle
- * complexes interactions occuring in a multi-call context.
+ * complexes interactions occurring in a multi-call context.
  */
 
 class TelephoneTone;

src/media/media_codec.h

@@ -159,7 +159,7 @@ struct AccountCodecInfo
     AccountCodecInfo& operator=(AccountCodecInfo&&);
 
     const SystemCodecInfo& systemCodecInfo;
-    unsigned order {0}; /*used to define prefered codec list order in UI*/
+    unsigned order {0}; /*used to define preferred codec list order in UI*/
     bool isActive {true};
     /* account custom values */
     unsigned payloadType;

src/preferences.cpp

@@ -139,7 +139,7 @@ constexpr const char * const VideoPreferences::CONFIG_LABEL;
 static const char * const DECODING_ACCELERATED_KEY = "decodingAccelerated";
 #endif
 
-static const char * const DFT_PULSE_LENGTH_STR = "250"; /** Default DTMF lenght */
+static const char * const DFT_PULSE_LENGTH_STR = "250"; /** Default DTMF length */
 static const char * const ALSA_DFT_CARD    = "0";          /** Default sound card index */
 
 Preferences::Preferences() :

src/ringdht/ringaccount.cpp

@@ -3468,7 +3468,7 @@ void RingAccount::setPushNotificationToken(const std::string& token)
 }
 
 /**
- * To be called by clients with relevent data when a push notification is received.
+ * To be called by clients with relevant data when a push notification is received.
  */
 void RingAccount::pushNotificationReceived(const std::string& from, const std::map<std::string, std::string>& data)
 {

src/ringdht/ringaccount.h

@@ -372,7 +372,7 @@ class RingAccount : public SIPAccountBase {
         void setPushNotificationToken(const std::string& pushDeviceToken = "");
 
         /**
-         * To be called by clients with relevent data when a push notification is received.
+         * To be called by clients with relevant data when a push notification is received.
          */
         void pushNotificationReceived(const std::string& from, const std::map<std::string, std::string>& data);