From 5d3a115bee88b659570e1a42bf13822314ac02b1 Mon Sep 17 00:00:00 2001 From: Josh Soref Date: Sat, 30 Oct 2021 21:04:30 -0400 Subject: [PATCH] include: Spelling fixes Correct typos of the following word families: activities forward occurs unprepared association compress extracted doubly callback prometheus underlying keyframe continue convenience calculates ignorepattern determine subscribers subsystem synthetic applies example manager established result microseconds occurrences unsuccessful accommodates related signifying unsubscribe greater fastforward itself unregistering using translator sorcery implementation serializers asynchronous unknowingly initialization determining category these persistent propagate outputted string allocated decremented second cacheability destructor impaired decrypted relies signaling based suspended retrieved functions search auth considered ASTERISK-29714 Change-Id: I542ce887a16603f886a915920d5710d4a0a1358d --- include/asterisk/abstract_jb.h | 2 +- include/asterisk/aoc.h | 2 +- include/asterisk/app.h | 2 +- include/asterisk/astdb.h | 2 +- include/asterisk/astmm.h | 2 +- include/asterisk/astobj2.h | 2 +- include/asterisk/bridge.h | 2 +- include/asterisk/bridge_features.h | 2 +- include/asterisk/bridge_roles.h | 4 ++-- include/asterisk/calendar.h | 2 +- include/asterisk/callerid.h | 2 +- include/asterisk/cdr.h | 4 ++-- include/asterisk/channel.h | 6 +++--- include/asterisk/config.h | 2 +- include/asterisk/config_options.h | 2 +- include/asterisk/crypto.h | 2 +- include/asterisk/devicestate.h | 4 ++-- include/asterisk/dlinkedlists.h | 4 ++-- include/asterisk/dns_core.h | 2 +- include/asterisk/doxygen/architecture.h | 2 +- include/asterisk/endpoints.h | 2 +- include/asterisk/event_defs.h | 2 +- include/asterisk/file.h | 6 +++--- include/asterisk/frame.h | 2 +- include/asterisk/framehook.h | 4 ++-- include/asterisk/hashtab.h | 4 ++-- include/asterisk/io.h | 2 +- include/asterisk/logger.h | 4 ++-- include/asterisk/manager.h | 6 +++--- include/asterisk/mod_format.h | 2 +- include/asterisk/module.h | 4 ++-- include/asterisk/pbx.h | 8 ++++---- include/asterisk/plc.h | 4 ++-- include/asterisk/privacy.h | 2 +- include/asterisk/res_mwi_external.h | 2 +- include/asterisk/res_odbc.h | 2 +- include/asterisk/res_pjsip.h | 16 ++++++++-------- include/asterisk/res_prometheus.h | 2 +- include/asterisk/rtp_engine.h | 2 +- include/asterisk/say.h | 2 +- include/asterisk/sem.h | 2 +- include/asterisk/sorcery.h | 2 +- include/asterisk/stasis.h | 4 ++-- include/asterisk/stasis_endpoints.h | 2 +- include/asterisk/stasis_message_router.h | 4 ++-- include/asterisk/stringfields.h | 2 +- include/asterisk/strings.h | 4 ++-- include/asterisk/taskprocessor.h | 2 +- include/asterisk/threadpool.h | 6 +++--- include/asterisk/time.h | 4 ++-- include/asterisk/translate.h | 2 +- include/asterisk/vector.h | 2 +- 52 files changed, 83 insertions(+), 83 deletions(-) diff --git a/include/asterisk/abstract_jb.h b/include/asterisk/abstract_jb.h index 3e2467de6b..a2a8827449 100644 --- a/include/asterisk/abstract_jb.h +++ b/include/asterisk/abstract_jb.h @@ -220,7 +220,7 @@ int ast_jb_put(struct ast_channel *chan, struct ast_frame *f); * * Called from ast_generic_bridge() to deliver any frames, that should be delivered * for the moment of invocation. Does nothing if neihter of the channels is using jb - * or has any frames currently queued in. The function delivers frames usig ast_write() + * or has any frames currently queued in. The function delivers frames using ast_write() * each of the channels. */ void ast_jb_get_and_deliver(struct ast_channel *c0, struct ast_channel *c1); diff --git a/include/asterisk/aoc.h b/include/asterisk/aoc.h index 171fbb300f..e04cdbca7e 100644 --- a/include/asterisk/aoc.h +++ b/include/asterisk/aoc.h @@ -332,7 +332,7 @@ int ast_aoc_set_billing_id(struct ast_aoc_decoded *decoded, const enum ast_aoc_b int ast_aoc_set_association_id(struct ast_aoc_decoded *decoded, const int id); /*! - * \brief set the charging accociation number for an AOC-E message + * \brief set the charging association number for an AOC-E message * \since 1.8 * * \param decoded ast_aoc_decoded struct to set values on diff --git a/include/asterisk/app.h b/include/asterisk/app.h index ab246c8b7d..560f85218e 100644 --- a/include/asterisk/app.h +++ b/include/asterisk/app.h @@ -1030,7 +1030,7 @@ int ast_control_tone(struct ast_channel *chan, const char *tone); * \param chan * \param file filename * \param fwd, rev, stop, pause, restart, skipms, offsetms - * \param cb waitstream callback to invoke when fastforward or rewind occurrs. + * \param cb waitstream callback to invoke when fastforward or rewind occurs. * * Before calling this function, set this to be the number * of ms to start from the beginning of the file. When the function diff --git a/include/asterisk/astdb.h b/include/asterisk/astdb.h index 383864baf9..c511be8a76 100644 --- a/include/asterisk/astdb.h +++ b/include/asterisk/astdb.h @@ -18,7 +18,7 @@ /*! * \file - * \brief Persistant data storage (akin to *doze registry) + * \brief Persistent data storage (akin to *doze registry) */ #ifndef _ASTERISK_ASTDB_H diff --git a/include/asterisk/astmm.h b/include/asterisk/astmm.h index e1f91ddeab..ba444bb718 100644 --- a/include/asterisk/astmm.h +++ b/include/asterisk/astmm.h @@ -295,7 +295,7 @@ int __ast_repl_vasprintf(char **strp, const char *format, va_list ap, const char * \param s The string to duplicate * * This macro will duplicate the given string. It returns a pointer to the stack - * allocatted memory for the new string. + * allocated memory for the new string. */ #define ast_strdupa(s) \ (__extension__ \ diff --git a/include/asterisk/astobj2.h b/include/asterisk/astobj2.h index a135db82e9..c32b7439b4 100644 --- a/include/asterisk/astobj2.h +++ b/include/asterisk/astobj2.h @@ -1792,7 +1792,7 @@ void *__ao2_weakproxy_find(struct ao2_container *c, const void *arg, enum search * * In addition, ao2_iterator_init() will hold a reference to the * container being iterated and the last container node found. - * Thes objects will be unreffed when ao2_iterator_destroy() is + * These objects will be unreffed when ao2_iterator_destroy() is * called to free up the resources used by the iterator (if * any). * diff --git a/include/asterisk/bridge.h b/include/asterisk/bridge.h index 6a7a395635..41eada676e 100644 --- a/include/asterisk/bridge.h +++ b/include/asterisk/bridge.h @@ -1056,7 +1056,7 @@ void ast_bridge_set_remb_estimated_bitrate(struct ast_bridge *bridge, float esti /*! * \brief Update information about talker energy for talker src video mode. */ -void ast_bridge_update_talker_src_video_mode(struct ast_bridge *bridge, struct ast_channel *chan, int talker_energy, int is_keyfame); +void ast_bridge_update_talker_src_video_mode(struct ast_bridge *bridge, struct ast_channel *chan, int talker_energy, int is_keyframe); /*! * \brief Returns the number of video sources currently active in the bridge diff --git a/include/asterisk/bridge_features.h b/include/asterisk/bridge_features.h index a752997fed..504efc5748 100644 --- a/include/asterisk/bridge_features.h +++ b/include/asterisk/bridge_features.h @@ -712,7 +712,7 @@ int ast_bridge_features_enable(struct ast_bridge_features *features, /*! * \brief Constructor function for ast_bridge_features_limits * - * \param limits pointer to a ast_bridge_features_limits struct that has been allocted, but not initialized + * \param limits pointer to a ast_bridge_features_limits struct that has been allocated, but not initialized * * \retval 0 on success * \retval -1 on failure diff --git a/include/asterisk/bridge_roles.h b/include/asterisk/bridge_roles.h index f91a6b0aa2..ab85530c1b 100644 --- a/include/asterisk/bridge_roles.h +++ b/include/asterisk/bridge_roles.h @@ -96,7 +96,7 @@ int ast_channel_has_role(struct ast_channel *channel, const char *role_name); * \retval non-NULL The value of the option * * This is an alternative to \ref ast_bridge_channel_get_role_option that is useful if bridge - * roles have not yet been esstablished on a channel's bridge_channel. A possible example of + * roles have not yet been established on a channel's bridge_channel. A possible example of * when this could be used is in a bridge v_table's push() callback. */ const char *ast_channel_get_role_option(struct ast_channel *channel, const char *role_name, const char *option); @@ -146,7 +146,7 @@ const char *ast_bridge_channel_get_role_option(struct ast_bridge_channel *bridge * \details * This function should always be called when the bridge_channel binds to an ast_channel at some point before the bridge_channel * joins or is imparted onto a bridge. Failure to do so will result in an empty role list. While the list remains established, - * changes to roles on the ast_channel will not propogate to the bridge channel and roles can not be re-established on the bridge + * changes to roles on the ast_channel will not propagate to the bridge channel and roles can not be re-established on the bridge * channel without first clearing the roles with ast_bridge_roles_bridge_channel_clear_roles. */ int ast_bridge_channel_establish_roles(struct ast_bridge_channel *bridge_channel); diff --git a/include/asterisk/calendar.h b/include/asterisk/calendar.h index 79d33fc022..7bb0c820f3 100644 --- a/include/asterisk/calendar.h +++ b/include/asterisk/calendar.h @@ -51,7 +51,7 @@ * a load_calendar callback which will be passed an ast_calendar_load_data structure. * The load_calendar callback function should then set the values it needs from this * cfg, load the calendar data, and then loop updating the calendar data and events - * baesd on the refresh interval in the ast_calendar object. Each call to + * based on the refresh interval in the ast_calendar object. Each call to * the load_calendar callback will be will run in its own thread. * * Updating events involves creating an astobj2 container of new events and passing diff --git a/include/asterisk/callerid.h b/include/asterisk/callerid.h index 143ffae23d..ac49b35605 100644 --- a/include/asterisk/callerid.h +++ b/include/asterisk/callerid.h @@ -202,7 +202,7 @@ int ast_callerid_callwaiting_generate(unsigned char *buf, const char *name, cons /*! \brief Destructively parse inbuf into name and location (or number) * \details - * Parses callerid stream from inbuf and changes into useable form, outputed in name and location. + * Parses callerid stream from inbuf and changes into useable form, outputted in name and location. * \param instr buffer of callerid stream (in audio form) to be parsed. Warning, data in buffer is changed. * \param name address of a pointer-to-char for the name value of the stream. * \param location address of a pointer-to-char for the phone number value of the stream. diff --git a/include/asterisk/cdr.h b/include/asterisk/cdr.h index c6b241315c..e86c6e1d46 100644 --- a/include/asterisk/cdr.h +++ b/include/asterisk/cdr.h @@ -354,7 +354,7 @@ void ast_cdr_set_config(struct ast_cdr_config *config); * \param ret Pointer to the formatted buffer * \param workspace A pointer to the buffer to use to format the variable * \param workspacelen The size of \ref workspace - * \param raw If non-zero and a date/time is extraced, provide epoch seconds. Otherwise format as a date/time stamp + * \param raw If non-zero and a date/time is extracted, provide epoch seconds. Otherwise format as a date/time stamp */ void ast_cdr_format_var(struct ast_cdr *cdr, const char *name, char **ret, char *workspace, int workspacelen, int raw); @@ -522,7 +522,7 @@ int ast_cdr_unregister(const char *name); /*! * \brief Suspend a CDR backend temporarily * - * \retval 0 The backend is suspdended + * \retval 0 The backend is suspended * \retval -1 The backend could not be suspended */ int ast_cdr_backend_suspend(const char *name); diff --git a/include/asterisk/channel.h b/include/asterisk/channel.h index b699c7479a..b59e4f151a 100644 --- a/include/asterisk/channel.h +++ b/include/asterisk/channel.h @@ -1559,7 +1559,7 @@ struct ast_channel *__ast_request_and_dial(const char *type, struct ast_format_c * \param timeout maximum amount of time to wait for setup of new forward channel * \param cap format capabilities for requested channel * \param oh outgoing helper used with original channel - * \param outstate reason why unsuccessful (if uncuccessful) + * \param outstate reason why unsuccessful (if unsuccessful) * \return Returns the forwarded call's ast_channel on success or NULL on failure */ struct ast_channel *ast_call_forward(struct ast_channel *caller, struct ast_channel *orig, int *timeout, struct ast_format_cap *cap, struct outgoing_helper *oh, int *outstate); @@ -2636,7 +2636,7 @@ int ast_autoservice_ignore(struct ast_channel *chan, enum ast_frame_type ftype); * * \note Call this function with a rate of 0 to turn off the timer ticks * - * \version 1.6.1 changed samples parameter to rate, accomodates new timing methods + * \version 1.6.1 changed samples parameter to rate, accommodates new timing methods */ int ast_settimeout(struct ast_channel *c, unsigned int rate, int (*func)(const void *data), void *data); int ast_settimeout_full(struct ast_channel *c, unsigned int rate, int (*func)(const void *data), void *data, unsigned int is_ao2_obj); @@ -4218,7 +4218,7 @@ struct ast_channel_monitor { int (*stop)(struct ast_channel *chan, int need_lock); }; -/* ACCESSOR FUNTIONS */ +/* ACCESSOR FUNCTIONS */ /*! \brief Set the channel name */ void ast_channel_name_set(struct ast_channel *chan, const char *name); diff --git a/include/asterisk/config.h b/include/asterisk/config.h index 1775dfe53c..f53116d7f3 100644 --- a/include/asterisk/config.h +++ b/include/asterisk/config.h @@ -902,7 +902,7 @@ int ast_category_inherit(struct ast_category *existing, const struct ast_categor * \param category category to empty * * \retval 0 if succeeded - * \retval -1 if categopry is NULL + * \retval -1 if category is NULL */ int ast_category_empty(struct ast_category *category); diff --git a/include/asterisk/config_options.h b/include/asterisk/config_options.h index 44299369d1..81b62e09c2 100644 --- a/include/asterisk/config_options.h +++ b/include/asterisk/config_options.h @@ -125,7 +125,7 @@ struct aco_type { const char *category; /*!< A regular expression for matching categories to be allowed or denied */ const char *matchfield; /*!< An option name to match for this type (i.e. a 'type'-like column) */ const char *matchvalue; /*!< The value of the option to require for matching (i.e. 'peer' for type= in sip.conf) */ - aco_matchvalue_func matchfunc; /*!< A function for determing whether the option value matches (i.e. hassip= requires ast_true()) */ + aco_matchvalue_func matchfunc; /*!< A function for determining whether the option value matches (i.e. hassip= requires ast_true()) */ enum aco_category_op category_match; /*!< Whether the following category regex is a whitelist or blacklist */ size_t item_offset; /*!< The offset in the config snapshot for the global config or item config container */ unsigned int hidden; /*!< Type is for internal purposes only and it and all options should not be visible to users */ diff --git a/include/asterisk/crypto.h b/include/asterisk/crypto.h index c911404d73..836abf4307 100644 --- a/include/asterisk/crypto.h +++ b/include/asterisk/crypto.h @@ -128,7 +128,7 @@ AST_OPTIONAL_API(int, ast_encrypt_bin, (unsigned char *dst, const unsigned char * \param dst a pointer to a buffer of at least srclen bytes in which the decrypted * answer will be stored * - * \retval length of dencrypted data on success. + * \retval length of decrypted data on success. * \retval -1 on failure. * */ diff --git a/include/asterisk/devicestate.h b/include/asterisk/devicestate.h index 5b2f04de4f..5d7e3a49d6 100644 --- a/include/asterisk/devicestate.h +++ b/include/asterisk/devicestate.h @@ -63,7 +63,7 @@ enum ast_device_state { }; /*! \brief Device State Cachability - * \note This is used to define the cachability of a device state when set. + * \note This is used to define the cacheability of a device state when set. */ enum ast_devstate_cache { AST_DEVSTATE_NOT_CACHABLE, /*!< This device state is not cachable */ @@ -248,7 +248,7 @@ struct ast_device_state_message { const struct ast_eid *eid; /*! The state of the device */ enum ast_device_state state; - /*! Flag designating the cachability of this device state */ + /*! Flag designating the cacheability of this device state */ enum ast_devstate_cache cachable; /*! The device and eid data is stuffed here when the struct is allocated. */ struct ast_eid stuff[0]; diff --git a/include/asterisk/dlinkedlists.h b/include/asterisk/dlinkedlists.h index 31e4d8ddbf..0bfa232dce 100644 --- a/include/asterisk/dlinkedlists.h +++ b/include/asterisk/dlinkedlists.h @@ -497,7 +497,7 @@ #define AST_RWDLLIST_IS_MEMBER AST_DLLIST_IS_MEMBER /*! - * \brief Traverse a doublly linked list using the specified direction list. + * \brief Traverse a doubly linked list using the specified direction list. * * \param head List head structure pointer. * \param var This is the name of the variable that will hold a pointer to the @@ -620,7 +620,7 @@ #define AST_RWDLLIST_TRAVERSE_BACKWARDS AST_DLLIST_TRAVERSE_BACKWARDS /*! - * \brief Safe traversal of a doublly linked list using the specified direction list. + * \brief Safe traversal of a doubly linked list using the specified direction list. * * \param head List head structure pointer. * \param var This is the name of the variable that will hold a pointer to the diff --git a/include/asterisk/dns_core.h b/include/asterisk/dns_core.h index d74b0123a3..3f2ac5dbe9 100644 --- a/include/asterisk/dns_core.h +++ b/include/asterisk/dns_core.h @@ -287,7 +287,7 @@ int ast_dns_resolve(const char *name, int rr_type, int rr_class, struct ast_dns_ * is used. * * \warning This function is synchronous and will block until records are returned or an error - * occurrs. + * occurs. */ int ast_dns_resolve_ipv6_and_ipv4(struct ast_sockaddr *address, const char *host, const char *port); diff --git a/include/asterisk/doxygen/architecture.h b/include/asterisk/doxygen/architecture.h index 315187016c..780b64f778 100644 --- a/include/asterisk/doxygen/architecture.h +++ b/include/asterisk/doxygen/architecture.h @@ -438,7 +438,7 @@ Asterisk CLI operates using connections to a UNIX %domain socket. There are other miscellaneous threads throughout the system that perform a specific task. For example, the event API (include/asterisk/event.h) uses a thread internally -(main/event.c) to handle asychronous event dispatching. The devicestate API +(main/event.c) to handle asynchronous event dispatching. The devicestate API (include/asterisk/devicestate.h) uses a thread internally (main/devicestate.c) to asynchronously process device state changes. diff --git a/include/asterisk/endpoints.h b/include/asterisk/endpoints.h index c9cb6b9de7..ee73dc6666 100644 --- a/include/asterisk/endpoints.h +++ b/include/asterisk/endpoints.h @@ -28,7 +28,7 @@ * * An endpoint is an external device/system that may offer/accept channels * to/from Asterisk. While this is a very useful concept for end users, it is - * surprisingly \a not a core concept within Asterisk iteself. + * surprisingly \a not a core concept within Asterisk itself. * * This file defines \ref ast_endpoint as a seperate object, which channel * drivers may use to expose their concept of an endpoint. As the channel driver diff --git a/include/asterisk/event_defs.h b/include/asterisk/event_defs.h index fd8330e805..fea89ef806 100644 --- a/include/asterisk/event_defs.h +++ b/include/asterisk/event_defs.h @@ -299,7 +299,7 @@ enum ast_event_ie_type { AST_EVENT_IE_PRESENCE_MESSAGE = 0x003c, /*! - * \brief Event non-cachability flag + * \brief Event non-cacheability flag * Used by: All events * Payload type: UINT */ diff --git a/include/asterisk/file.h b/include/asterisk/file.h index 1c2c7a84a0..7e5442626d 100644 --- a/include/asterisk/file.h +++ b/include/asterisk/file.h @@ -59,7 +59,7 @@ enum ast_waitstream_fr_cb_values { /*! * \brief callback used during dtmf controlled file playback to indicate - * location of playback in a file after rewinding or fastfowarding + * location of playback in a file after rewinding or fastforwarding * a file. */ typedef void (ast_waitstream_fr_cb)(struct ast_channel *chan, long ms, enum ast_waitstream_fr_cb_values val); @@ -218,7 +218,7 @@ int ast_waitstream_fr(struct ast_channel *c, const char *breakon, const char *fo * \param forward DTMF digit to fast forward upon * \param rewind DTMF digit to rewind upon * \param ms How many milliseconds to skip forward/back - * \param cb to call when rewind or fastfoward occurs. + * \param cb to call when rewind or fastforward occurs. * Begins playback of a stream... * Wait for a stream to stop or for any one of a given digit to arrive, * \retval 0 if the stream finishes. @@ -324,7 +324,7 @@ struct ast_filestream *ast_openstream_full(struct ast_channel *chan, const char struct ast_filestream *ast_openvstream(struct ast_channel *chan, const char *filename, const char *preflang); /*! - * \brief Applys a open stream to a channel. + * \brief Applies a open stream to a channel. * \param chan channel to work * \param s ast_filestream to apply * \retval 0 on success. diff --git a/include/asterisk/frame.h b/include/asterisk/frame.h index 0e623d3311..f637c97ae8 100644 --- a/include/asterisk/frame.h +++ b/include/asterisk/frame.h @@ -430,7 +430,7 @@ struct ast_control_pvt_cause_code { * Option data is a single signed char value 0 or 1 */ #define AST_OPTION_TONE_VERIFY 1 -/*! Put a compatible channel into TDD (TTY for the hearing-impared) mode +/*! Put a compatible channel into TDD (TTY for the hearing-impaired) mode * Option data is a single signed char value 0 or 1 */ #define AST_OPTION_TDD 2 diff --git a/include/asterisk/framehook.h b/include/asterisk/framehook.h index 8e5afaeae9..7cf731d783 100644 --- a/include/asterisk/framehook.h +++ b/include/asterisk/framehook.h @@ -177,7 +177,7 @@ enum ast_framehook_event { * \param channel, The ast_channel this framehook is attached to * \param frame, The ast_frame being intercepted for viewing and manipulation * \param event, The type of event which is occurring - * \param data, The data pointer provided at framehook initilization. + * \param data, The data pointer provided at framehook initialization. * * \retval the resulting frame. */ @@ -204,7 +204,7 @@ typedef void (*ast_framehook_destroy_callback)(void *data); * frames of a given type * \since 12 * - * \param data, The data pointer provided at framehook initilization. + * \param data, The data pointer provided at framehook initialization. * \param type, The type of frame. * * \return 0 if frame type is being ignored diff --git a/include/asterisk/hashtab.h b/include/asterisk/hashtab.h index 64ed1bf6fe..88fb4f60a6 100644 --- a/include/asterisk/hashtab.h +++ b/include/asterisk/hashtab.h @@ -127,7 +127,7 @@ int ast_is_prime(int num); * \param b a character string * \retval 0 if the strings match * \retval <0 if string a is less than string b - * \retval >0 if string a is greather than string b + * \retval >0 if string a is greater than string b */ int ast_hashtab_compare_strings(const void *a, const void *b); @@ -138,7 +138,7 @@ int ast_hashtab_compare_strings(const void *a, const void *b); * \param b a character string * \retval 0 if the strings match * \retval <0 if string a is less than string b - * \retval >0 if string a is greather than string b + * \retval >0 if string a is greater than string b */ int ast_hashtab_compare_strings_nocase(const void *a, const void *b); diff --git a/include/asterisk/io.h b/include/asterisk/io.h index e9b155985e..e8a36a6280 100644 --- a/include/asterisk/io.h +++ b/include/asterisk/io.h @@ -79,7 +79,7 @@ typedef int (*ast_io_cb)(int *id, int fd, short events, void *cbdata); * \param callback callback function to run * \param events event mask of events to wait for * \param data data to pass to the callback - * Watch for any of revents activites on fd, calling callback with data as + * Watch for any of revents activities on fd, calling callback with data as * callback data. * \retval a pointer to ID of the IO event * \retval NULL on failure diff --git a/include/asterisk/logger.h b/include/asterisk/logger.h index 4234262063..170fb68fd7 100644 --- a/include/asterisk/logger.h +++ b/include/asterisk/logger.h @@ -550,7 +550,7 @@ To start using it: * Use the cli or cli.conf to enable tracing: CLI> core set trace [ module ] Its simplest usage requires only 1 macro call that... - - Registers a descructor for a special variable that gets called when the + - Registers a destructor for a special variable that gets called when the variable goes out of scope. Uses the same principle as RAII_VAR. The destructor prints the name of the function with an "exiting" indicator along with an optional message. @@ -827,7 +827,7 @@ unsigned long _ast_trace_dec_indent(void); * if (something) { * SCOPE_EXIT_EXPR(break, "Somethiung broke me\n"); * } else { - * SCOPE_EXIT_EXPR(contniue, "Somethiung continued me\n"); + * SCOPE_EXIT_EXPR(continue, "Somethiung continued me\n"); * } * } */ diff --git a/include/asterisk/manager.h b/include/asterisk/manager.h index 741b238586..4fbb3d8679 100644 --- a/include/asterisk/manager.h +++ b/include/asterisk/manager.h @@ -173,7 +173,7 @@ struct manager_action { * \brief TRUE if the AMI action is registered and the callback can be called. * * \note Needed to prevent a race between calling the callback - * function and unregestring the AMI action object. + * function and unregistering the AMI action object. */ unsigned int registered:1; }; @@ -269,7 +269,7 @@ int __ast_manager_event_multichan(int category, const char *event, int chancount struct ast_channel **chans, const char *file, int line, const char *func, const char *contents, ...) __attribute__((format(printf, 8, 9))); -/*! \brief Get header from mananger transaction */ +/*! \brief Get header from manager transaction */ const char *astman_get_header(const struct message *m, char *var); /*! \brief Get a linked list of the Variable: headers @@ -353,7 +353,7 @@ void astman_send_list_complete_end(struct mansession *s); void __attribute__((format(printf, 2, 3))) astman_append(struct mansession *s, const char *fmt, ...); -/*! \brief Determinie if a manager session ident is authenticated */ +/*! \brief Determine if a manager session ident is authenticated */ int astman_is_authed(uint32_t ident); /*! diff --git a/include/asterisk/mod_format.h b/include/asterisk/mod_format.h index 6e772f05b2..8066c3dfe0 100644 --- a/include/asterisk/mod_format.h +++ b/include/asterisk/mod_format.h @@ -110,7 +110,7 @@ struct ast_filestream { struct ast_filestream *vfs; /*! Transparently translate from another format -- just once */ struct ast_trans_pvt *trans; - struct ast_tranlator_pvt *tr; + struct ast_translator_pvt *tr; struct ast_format *lastwriteformat; int lasttimeout; struct ast_channel *owner; diff --git a/include/asterisk/module.h b/include/asterisk/module.h index 2720d0e04a..cce8735fc1 100644 --- a/include/asterisk/module.h +++ b/include/asterisk/module.h @@ -181,7 +181,7 @@ enum ast_module_reload_result ast_module_reload(const char *name); /*! * \brief Notify when usecount has been changed. * - * This function calulates use counts and notifies anyone trying to keep track + * This function calculates use counts and notifies anyone trying to keep track * of them. It should be called whenever your module's usecount changes. * * \note The ast_module_user_* functions take care of calling this function for you. @@ -352,7 +352,7 @@ struct ast_module_info { const char *description; /*! - * This holds the ASTERISK_GPL_KEY, signifiying that you agree to the terms of + * This holds the ASTERISK_GPL_KEY, signifying that you agree to the terms of * the Asterisk license as stated in the ASTERISK_GPL_KEY. Your module will not * load if it does not return the EXACT key string. */ diff --git a/include/asterisk/pbx.h b/include/asterisk/pbx.h index c75e50a3ba..bc34b66ead 100644 --- a/include/asterisk/pbx.h +++ b/include/asterisk/pbx.h @@ -144,7 +144,7 @@ struct ast_custom_function { * 'dangerous', and should not be run directly * from external interfaces (AMI, ARI, etc.) * \since 12 */ - unsigned int write_escalates:1; /*!< The write function is to be considerd + unsigned int write_escalates:1; /*!< The write function is to be considered * 'dangerous', and should not be run directly * from external interfaces (AMI, ARI, etc.) * \since 12 */ @@ -789,7 +789,7 @@ int ast_findlabel_extension2(struct ast_channel *c, struct ast_context *con, * \brief Looks for a valid matching extension * * \param c not really important - * \param context context to serach within + * \param context context to search within * \param exten extension to check * \param priority priority of extension path * \param callerid callerid of extension being searched for @@ -809,7 +809,7 @@ int ast_canmatch_extension(struct ast_channel *c, const char *context, * \brief Looks to see if adding anything to this extension might match something. (exists ^ canmatch) * * \param c not really important XXX - * \param context context to serach within + * \param context context to search within * \param exten extension to check * \param priority priority of extension path * \param callerid callerid of extension being searched for @@ -1013,7 +1013,7 @@ int ast_context_remove_extension_callerid2(struct ast_context *con, const char * /*! * \brief Add an ignorepat * - * \param context which context to add the ignorpattern to + * \param context which context to add the ignorepattern to * \param ignorepat ignorepattern to set up for the extension * \param registrar registrar of the ignore pattern * diff --git a/include/asterisk/plc.h b/include/asterisk/plc.h index cd650012c8..942e6ab4ed 100644 --- a/include/asterisk/plc.h +++ b/include/asterisk/plc.h @@ -75,7 +75,7 @@ are needed to obtain smooth pleasant sounding results. correct steadily fall. Therefore, the volume of the synthesized signal is made to decay linearly, such that after 50ms of missing audio it is reduced to silence. -- When real speech resumes, an extra 1/4 pitch period of sythetic speech is blended with the +- When real speech resumes, an extra 1/4 pitch period of synthetic speech is blended with the start of the real speech. If the erasure is small, this smoothes the transition. If the erasure is long, and the synthetic signal has faded to zero, the blending softens the start up of the real signal, avoiding a kind of "click" or "pop" effect that might occur with a sudden onset. @@ -85,7 +85,7 @@ Before audio is processed, call plc_init() to create an instance of the packet l concealer. For each received audio packet that is acceptable (i.e. not including those being dropped for being too late) call plc_rx() to record the content of the packet. Note this may modify the packet a little after a period of packet loss, to blend real synthetic data smoothly. -When a real packet is not available in time, call plc_fillin() to create a sythetic substitute. +When a real packet is not available in time, call plc_fillin() to create a synthetic substitute. That's it! */ diff --git a/include/asterisk/privacy.h b/include/asterisk/privacy.h index 686a14d756..6040129a82 100644 --- a/include/asterisk/privacy.h +++ b/include/asterisk/privacy.h @@ -17,7 +17,7 @@ */ /*! \file - * \brief Persistant data storage (akin to *doze registry) + * \brief Persistent data storage (akin to *doze registry) */ #ifndef _ASTERISK_PRIVACY_H diff --git a/include/asterisk/res_mwi_external.h b/include/asterisk/res_mwi_external.h index 25de70003a..19385d5833 100644 --- a/include/asterisk/res_mwi_external.h +++ b/include/asterisk/res_mwi_external.h @@ -38,7 +38,7 @@ extern "C" struct ast_mwi_mailbox_object; -/*! \brief Convienience unref function for mailbox object. */ +/*! \brief Convenience unref function for mailbox object. */ #define ast_mwi_mailbox_unref(mailbox) ao2_ref((struct ast_mwi_mailbox_object *) mailbox, -1) /*! diff --git a/include/asterisk/res_odbc.h b/include/asterisk/res_odbc.h index 9a38915bc1..789cabac2c 100644 --- a/include/asterisk/res_odbc.h +++ b/include/asterisk/res_odbc.h @@ -170,7 +170,7 @@ SQLHSTMT ast_odbc_prepare_and_execute(struct odbc_obj *obj, SQLHSTMT (*prepare_c */ int ast_odbc_prepare(struct odbc_obj *obj, SQLHSTMT *stmt, const char *sql); -/*! \brief Execute a nonprepared SQL query. +/*! \brief Execute a unprepared SQL query. * \param obj The ODBC object * \param sql The SQL query * \note This should be used in place of SQLExecDirect diff --git a/include/asterisk/res_pjsip.h b/include/asterisk/res_pjsip.h index 2a20e36935..9c1594dd7c 100644 --- a/include/asterisk/res_pjsip.h +++ b/include/asterisk/res_pjsip.h @@ -1907,7 +1907,7 @@ struct ast_sip_sched_task; * \ref AST_SIP_SCHED_TASK_PERIODIC specifies that the invocations of the task occur at the * specific interval. That is, every \ref "interval" milliseconds, regardless of how long the task * takes. If the task takes longer than \ref interval, it will be scheduled at the next available - * multiple of \ref interval. For exmaple: If the task has an interval of 60 seconds and the task + * multiple of \ref interval. For example: If the task has an interval of 60 seconds and the task * takes 70 seconds, the next invocation will happen at 120 seconds. * * \ref AST_SIP_SCHED_TASK_DELAY specifies that the next invocation of the task should start @@ -2122,7 +2122,7 @@ pjsip_dialog *ast_sip_create_dialog_uas(const struct ast_sip_endpoint *endpoint, * occurs. * * As long as the caller maintains a reference to the dialog there should be no - * worry that it might unknowningly be destroyed. However, once the caller unlocks + * worry that it might unknowingly be destroyed. However, once the caller unlocks * the dialog there is a danger that some of the dialog's internal objects could * be lost and/or compromised. For example, when the aforementioned transport error * occurs the dialog's associated transaction gets destroyed (see pjsip_dlg_on_tsx_state @@ -2559,7 +2559,7 @@ void ast_sip_cleanup_auths(struct ast_sip_auth *auths[], size_t num_auths); * number of auth ids supplied if auth objects couldn't be found for * some of them. * - * \NOTE Since the ref count on all auith objects returned has been + * \NOTE Since the ref count on all auth objects returned has been * bumped, you must call ast_sip_cleanup_auth_objects_vector() to decrement * the ref count on all of the auth objects in the vector, * then call AST_VECTOR_FREE() on the vector itself. @@ -2871,7 +2871,7 @@ int ast_sip_format_auths_ami(const struct ast_sip_auth_vector *auths, /*! * \brief Retrieve the endpoint snapshot for an endpoint * - * \param endpoint The endpoint whose snapshot is to be retreieved. + * \param endpoint The endpoint whose snapshot is to be retrieved. * \retval The endpoint snapshot */ struct ast_endpoint_snapshot *ast_sip_get_endpoint_snapshot( @@ -3564,12 +3564,12 @@ enum ast_transport_monitor_reg ast_sip_transport_monitor_register_replace(pjsip_ * \param transport Transport to monitor for shutdown. * \param cb The callback that was used for the original register. * \param data Data to pass to the matcher. May be NULL and does NOT need to be an ao2 object. - * If NULL, all monitors with the provided callbck are unregistered. + * If NULL, all monitors with the provided callback are unregistered. * \param matches Matcher function that returns true if data matches the previously * registered data object. If NULL, a simple pointer comparison is done. * * \note The data object passed into the original register will have its reference count - * automatically decremeneted. + * automatically decremented. * * \return Nothing */ @@ -3582,12 +3582,12 @@ void ast_sip_transport_monitor_unregister(pjsip_transport *transport, * * \param cb The callback that was used for the original register. * \param data Data to pass to the matcher. May be NULL and does NOT need to be an ao2 object. - * If NULL, all monitors with the provided callbck are unregistered. + * If NULL, all monitors with the provided callback are unregistered. * \param matches Matcher function that returns true if ao2_data matches the previously * registered data object. If NULL, a simple pointer comparison is done. * * \note The data object passed into the original register will have its reference count - * automatically decremeneted. + * automatically decremented. * * \return Nothing */ diff --git a/include/asterisk/res_prometheus.h b/include/asterisk/res_prometheus.h index 4b6ce16be5..5da60d6a80 100644 --- a/include/asterisk/res_prometheus.h +++ b/include/asterisk/res_prometheus.h @@ -379,7 +379,7 @@ void prometheus_metric_to_string(struct prometheus_metric *metric, * server. For metrics that are generated often or whose value needs to be * stored, metrics can be created and registered. For metrics that can be * obtained "on-the-fly", this mechanism is preferred. When the HTTP route is - * queried by promtheus, the registered callbacks are invoked. The string passed + * queried by prometheus, the registered callbacks are invoked. The string passed * to the callback should be populated with stack-allocated metrics using * \c prometheus_metric_to_string. * diff --git a/include/asterisk/rtp_engine.h b/include/asterisk/rtp_engine.h index 0584f2cab5..bd945cf65d 100644 --- a/include/asterisk/rtp_engine.h +++ b/include/asterisk/rtp_engine.h @@ -1519,7 +1519,7 @@ void ast_rtp_codecs_payloads_set_m_type(struct ast_rtp_codecs *codecs, struct as * \param instance Optionally the instance that the codecs structure belongs to * \param payload Numerical payload that was seen in the a=rtpmap: SDP line * \param mimetype The string mime type that was seen - * \param mimesubtype The strin mime sub type that was seen + * \param mimesubtype The string mime sub type that was seen * \param options Optional options that may change the behavior of this specific payload * * \retval 0 success diff --git a/include/asterisk/say.h b/include/asterisk/say.h index 5e55b0f62c..5d5c2b831d 100644 --- a/include/asterisk/say.h +++ b/include/asterisk/say.h @@ -112,7 +112,7 @@ SAY_EXTERN int (* ast_say_ordinal_full)(struct ast_channel *chan, int num, const * \param lang language to speak the enumeration * \param options set to 'f' for female, 'm' for male, 'c' for commune, 'n' for neuter * \details - * Vocally says an enumeration on a given channel (first, sencond, third, forth, thirtyfirst, hundredth, ....) + * Vocally says an enumeration on a given channel (first, second, third, forth, thirtyfirst, hundredth, ....) * Especially useful for dates and messages. Says 'last' if num equals to INT_MAX * \retval 0 on success * \retval DTMF digit on interrupt diff --git a/include/asterisk/sem.h b/include/asterisk/sem.h index fcab82a5e2..e887cee1a5 100644 --- a/include/asterisk/sem.h +++ b/include/asterisk/sem.h @@ -85,7 +85,7 @@ struct ast_sem { int waiters; /*! Mutual exclusion */ ast_mutex_t mutex; - /*! Condition for singalling waiters */ + /*! Condition for signaling waiters */ ast_cond_t cond; }; diff --git a/include/asterisk/sorcery.h b/include/asterisk/sorcery.h index c3e2864ace..b6a9aedb0b 100644 --- a/include/asterisk/sorcery.h +++ b/include/asterisk/sorcery.h @@ -1513,7 +1513,7 @@ const char *ast_sorcery_object_get_id(const void *object); /*! * \since 14.0.0 - * \brief Get when the socery object was created + * \brief Get when the sorcery object was created * * \param object Pointer to a sorcery object * diff --git a/include/asterisk/stasis.h b/include/asterisk/stasis.h index 275dc1e174..e18b886784 100644 --- a/include/asterisk/stasis.h +++ b/include/asterisk/stasis.h @@ -71,7 +71,7 @@ * named, which is useful in debugging. * * Topics themselves are reference counted objects. Since topics are referred to - * by their subscibers, they will not be freed until all of their subscribers + * by their subscribers, they will not be freed until all of their subscribers * have unsubscribed. Topics are also thread safe, so no worries about * publishing/subscribing/unsubscribing to a topic concurrently from multiple * threads. It's also designed to handle the case of unsubscribing from a topic @@ -1185,7 +1185,7 @@ struct stasis_caching_topic *stasis_caching_unsubscribe( * \brief Unsubscribes a caching topic from its upstream topic, blocking until * all messages have been forwarded. * - * See stasis_unsubscriben_and_join() for more info on when to use this as + * See stasis_unsubscribe_and_join() for more info on when to use this as * opposed to stasis_caching_unsubscribe(). * * \param caching_topic Caching topic to unsubscribe diff --git a/include/asterisk/stasis_endpoints.h b/include/asterisk/stasis_endpoints.h index 2fbe5f4b70..71b7c59339 100644 --- a/include/asterisk/stasis_endpoints.h +++ b/include/asterisk/stasis_endpoints.h @@ -175,7 +175,7 @@ struct stasis_topic *ast_endpoint_topic_cached(struct ast_endpoint *endpoint); struct stasis_cp_all *ast_endpoint_cache_all(void); /*! - * \brief Topic for all endpoint releated messages. + * \brief Topic for all endpoint related messages. * \since 12 */ struct stasis_topic *ast_endpoint_topic_all(void); diff --git a/include/asterisk/stasis_message_router.h b/include/asterisk/stasis_message_router.h index ba3f8bbaa6..c186b615e4 100644 --- a/include/asterisk/stasis_message_router.h +++ b/include/asterisk/stasis_message_router.h @@ -155,7 +155,7 @@ int stasis_message_router_set_congestion_limits(struct stasis_message_router *ro * * \param router Router to add the route to. * \param message_type Type of message to route. - * \param callback Callback to forard messages of \a message_type to. + * \param callback Callback to forward messages of \a message_type to. * \param data Data pointer to pass to \a callback. * * \retval 0 on success @@ -179,7 +179,7 @@ int stasis_message_router_add(struct stasis_message_router *router, * * \param router Router to add the route to. * \param message_type Subtype of cache update to route. - * \param callback Callback to forard messages of \a message_type to. + * \param callback Callback to forward messages of \a message_type to. * \param data Data pointer to pass to \a callback. * * \retval 0 on success diff --git a/include/asterisk/stringfields.h b/include/asterisk/stringfields.h index ce978901b6..e2e72a94c2 100644 --- a/include/asterisk/stringfields.h +++ b/include/asterisk/stringfields.h @@ -412,7 +412,7 @@ int __ast_string_field_init(struct ast_string_field_mgr *mgr, struct ast_string_ /*! * \brief Allocate a structure with embedded stringfields in a single allocation - * \param n Current imlementation only allows 1 structure to be allocated + * \param n Current implementation only allows 1 structure to be allocated * \param type The type of structure to allocate * \param size The number of bytes of space (minimum) to allocate for stringfields to use * in each structure diff --git a/include/asterisk/strings.h b/include/asterisk/strings.h index 881cf89758..9ca3234d10 100644 --- a/include/asterisk/strings.h +++ b/include/asterisk/strings.h @@ -898,7 +898,7 @@ struct ast_str *__ast_str_thread_get(struct ast_threadstorage *ts, /*! * \brief Error codes from __ast_str_helper() - * The undelying processing to manipulate dynamic string is done + * The underlying processing to manipulate dynamic string is done * by __ast_str_helper(), which can return a success or a * permanent failure (e.g. no memory). */ @@ -1430,7 +1430,7 @@ int ast_strings_match(const char *left, const char *op, const char *right); * \warning The original string and *buffer will be modified. * * \details - * Both '\n' and '\r\n' are treated as single delimiters but consecutive occurrances of + * Both '\n' and '\r\n' are treated as single delimiters but consecutive occurrences of * the delimiters are NOT considered to be a single delimiter. This preserves blank * lines in the input. * diff --git a/include/asterisk/taskprocessor.h b/include/asterisk/taskprocessor.h index 5145565c6d..fca3edc02a 100644 --- a/include/asterisk/taskprocessor.h +++ b/include/asterisk/taskprocessor.h @@ -352,7 +352,7 @@ unsigned int ast_taskprocessor_alert_get(void); /*! - * \brief Get the current taskprocessor high water alert count by sybsystem. + * \brief Get the current taskprocessor high water alert count by subsystem. * \since 13.26.0 * \since 16.3.0 * diff --git a/include/asterisk/threadpool.h b/include/asterisk/threadpool.h index 77ab8a84a3..9474ede941 100644 --- a/include/asterisk/threadpool.h +++ b/include/asterisk/threadpool.h @@ -214,7 +214,7 @@ struct ast_serializer_shutdown_group *ast_serializer_shutdown_group_alloc(void); * \param timeout Number of seconds to wait for the serializers in the group to shutdown. * Zero if the timeout is disabled. * - * \return Number of seriaizers that did not get shutdown within the timeout. + * \return Number of serializers that did not get shutdown within the timeout. */ int ast_serializer_shutdown_group_join(struct ast_serializer_shutdown_group *shutdown_group, int timeout); @@ -246,7 +246,7 @@ struct ast_taskprocessor *ast_threadpool_serializer_get_current(void); * * While it guarantees that each task will complete before executing the next, * there is no guarantee as to which thread from the \c pool individual tasks - * will execute. This normally only matters if your code relys on thread + * will execute. This normally only matters if your code relies on thread * specific information, such as thread locals. * * Use ast_taskprocessor_unreference() to dispose of the returned \ref @@ -274,7 +274,7 @@ struct ast_taskprocessor *ast_threadpool_serializer(const char *name, struct ast * * While it guarantees that each task will complete before executing the next, * there is no guarantee as to which thread from the \c pool individual tasks - * will execute. This normally only matters if your code relys on thread + * will execute. This normally only matters if your code relies on thread * specific information, such as thread locals. * * Use ast_taskprocessor_unreference() to dispose of the returned \ref diff --git a/include/asterisk/time.h b/include/asterisk/time.h index aec6c7db2b..e2ab513384 100644 --- a/include/asterisk/time.h +++ b/include/asterisk/time.h @@ -108,7 +108,7 @@ int ast_tvzero(const struct timeval t), ) /*! - * \brief Compres two \c struct \c timeval instances returning + * \brief Compress two \c struct \c timeval instances returning * -1, 0, 1 if the first arg is smaller, equal or greater to the second. */ AST_INLINE_API( @@ -263,7 +263,7 @@ enum TIME_UNIT { * given string at least starts with one of the form values it will match. * * For example: us, usec, microsecond will all map to TIME_UNIT_MICROSECOND. - * So will uss, usecs, miscroseconds, or even microsecondvals + * So will uss, usecs, microseconds, or even microsecondvals * * Matching is also not case sensitive. * diff --git a/include/asterisk/translate.h b/include/asterisk/translate.h index b2da453268..4a6d4f495a 100644 --- a/include/asterisk/translate.h +++ b/include/asterisk/translate.h @@ -258,7 +258,7 @@ int __ast_register_translator(struct ast_translator *t, struct ast_module *modul /*! * \brief Unregister a translator - * Unregisters the given tranlator + * Unregisters the given translator * \param t translator to unregister * \return 0 on success, -1 on failure */ diff --git a/include/asterisk/vector.h b/include/asterisk/vector.h index 00d701bf0f..93e11c307d 100644 --- a/include/asterisk/vector.h +++ b/include/asterisk/vector.h @@ -800,7 +800,7 @@ int ast_vector_string_split(struct ast_vector_string *dest, * * \note The type of the returned vector must be traceable to the original vector. * - * The following will resut in "error: assignment from incompatible pointer type" + * The following will result in "error: assignment from incompatible pointer type" * because these declare 2 different structures. * * \code