[vlc-commits] [Git][videolan/vlc][master] include: fix typos in documentation
Steve Lhomme (@robUx4)
gitlab at videolan.org
Fri Feb 16 10:04:03 UTC 2024
Steve Lhomme pushed to branch master at VideoLAN / VLC
Commits:
d79286ac by Alexandre Janniaux at 2024-02-16T09:42:46+00:00
include: fix typos in documentation
- - - - -
13 changed files:
- include/vlc/libvlc_media_player.h
- include/vlc_ancillary.h
- include/vlc_aout.h
- include/vlc_codec.h
- include/vlc_diffutil.h
- include/vlc_es_out.h
- include/vlc_http.h
- include/vlc_httpd.h
- include/vlc_intf_strings.h
- include/vlc_sout.h
- include/vlc_stream.h
- include/vlc_url.h
- include/vlc_vout_display.h
Changes:
=====================================
include/vlc/libvlc_media_player.h
=====================================
@@ -443,7 +443,7 @@ typedef void (*libvlc_video_cleanup_cb)(void *opaque);
* \warning Rendering video into custom memory buffers is considerably less
* efficient than rendering in a custom window as normal.
*
- * For optimal perfomances, VLC media player renders into a custom window, and
+ * For optimal performances, VLC media player renders into a custom window, and
* does not use this function and associated callbacks. It is <b>highly
* recommended</b> that other LibVLC-based application do likewise.
* To embed video in a window, use libvlc_media_player_set_xwindow() or
@@ -758,8 +758,8 @@ typedef enum libvlc_video_output_mouse_button_t {
* is (width,height) as reported by \ref libvlc_video_output_resize_cb.
*
* \param opaque parameter passed to \ref libvlc_video_output_set_window_cb. [IN]
- * \param x horizontal mouse positon in \ref libvlc_video_output_resize_cb coordinates. [IN]
- * \param y vertical mouse positon in \ref libvlc_video_output_resize_cb coordinates. [IN]
+ * \param x horizontal mouse position in \ref libvlc_video_output_resize_cb coordinates. [IN]
+ * \param y vertical mouse position in \ref libvlc_video_output_resize_cb coordinates. [IN]
*/
typedef void (*libvlc_video_output_mouse_move_cb)(void *opaque, int x, int y);
@@ -792,7 +792,7 @@ typedef void (*libvlc_video_output_mouse_release_cb)(void *opaque, libvlc_video_
*
* It may be called before the \ref libvlc_video_output_setup_cb callback.
*
- * \warning These callbacks cannot be called concurently, the caller is responsible for serialization
+ * \warning These callbacks cannot be called concurrently, the caller is responsible for serialization
*
* \param[in] opaque private pointer set on the opaque parameter of @a libvlc_video_output_setup_cb()
* \param[in] report_size_change callback which must be called when the host size changes.
@@ -1184,7 +1184,7 @@ void libvlc_audio_set_format_callbacks( libvlc_media_player_t *mp,
* - "S32N" for signed 32-bit PCM
* - "FL32" for single precision IEEE 754
*
- * All supported formats use the native endianess.
+ * All supported formats use the native endianness.
* If there are more than one channel, samples are interleaved.
*
* \param mp the media player
@@ -2256,7 +2256,7 @@ LIBVLC_API int libvlc_video_get_adjust_int( libvlc_media_player_t *p_mi,
* starting (arg !0) or stopping (arg 0) the adjust filter.
*
* \param p_mi libvlc media player instance
- * \param option adust option to set, values of libvlc_video_adjust_option_t
+ * \param option adjust option to set, values of libvlc_video_adjust_option_t
* \param value adjust option value
* \version LibVLC 1.1.1 and later.
*/
@@ -2278,7 +2278,7 @@ LIBVLC_API float libvlc_video_get_adjust_float( libvlc_media_player_t *p_mi,
* are ignored.
*
* \param p_mi libvlc media player instance
- * \param option adust option to set, values of libvlc_video_adjust_option_t
+ * \param option adjust option to set, values of libvlc_video_adjust_option_t
* \param value adjust option value
* \version LibVLC 1.1.1 and later.
*/
@@ -2413,7 +2413,7 @@ LIBVLC_API void libvlc_audio_output_device_list_release(
* \param device_id device identifier string
* (see \ref libvlc_audio_output_device_t::psz_device)
*
- * \return If the change of device was requested succesfully, zero is returned
+ * \return If the change of device was requested successfully, zero is returned
* (the actual change is asynchronous and not guaranteed to succeed).
* On error, a non-zero value is returned.
*/
=====================================
include/vlc_ancillary.h
=====================================
@@ -96,7 +96,7 @@ vlc_ancillary_Create(void *data, vlc_ancillary_id id)
/**
* Release an ancillary
*
- * If the refcount reachs 0, the free_cb provided by
+ * If the refcount reaches 0, the free_cb provided by
* vlc_ancillary_CreateWithFreeCb() is called.
*
* @param ancillary ancillary to release
=====================================
include/vlc_aout.h
=====================================
@@ -386,7 +386,7 @@ static inline void aout_HotplugReport(audio_output_t *aout,
* Request a change of software audio amplification.
* \param aout the audio output instance requesting software gain
* \param gain linear amplitude gain (must be positive)
- * \warning Values in excess 1.0 may cause overflow and distorsion.
+ * \warning Values in excess 1.0 may cause overflow and distortion.
*/
static inline int aout_GainRequest(audio_output_t *aout, float gain)
{
=====================================
include/vlc_codec.h
=====================================
@@ -186,7 +186,7 @@ struct decoder_t
* If set, it *may* be called after pf_packetize returned data. It should
* return CC for the pictures returned by the last pf_packetize call only,
* channel bitmaps will be used to known which cc channel are present (but
- * globaly, not necessary for the current packet. Video decoders should use
+ * globally, not necessary for the current packet. Video decoders should use
* the decoder_QueueCc() function to pass closed captions. */
vlc_frame_t * ( * pf_get_cc ) ( decoder_t *, decoder_cc_desc_t * );
=====================================
include/vlc_diffutil.h
=====================================
@@ -24,7 +24,7 @@
#include <vlc_vector.h>
/**
- * this struture defines callback to access and compare elements from
+ * this structure defines callback to access and compare elements from
* the old and the new list
*/
typedef struct {
@@ -58,7 +58,7 @@ typedef struct {
void (*remove)(void* opaque, const void* listOld, uint32_t posOld, const void* listNew, uint32_t posNew);
/**
* notify that the item as @a posOld from the old list @a listOld is unchanged, the respective item
- * position in the new list is at the positoin @a posNew in @a listNew
+ * position in the new list is at the position @a posNew in @a listNew
*/
void (*equal)(void* opaque, const void* listOld, uint32_t posOld, const void* listNew, uint32_t posNew);
} vlc_diffutil_snake_callback_t;
@@ -78,7 +78,7 @@ enum vlc_diffutil_op_type {
/**
- * The data positionned at newModel[ y ] is inserted at position index
+ * The data positioned at newModel[ y ] is inserted at position index
* in the current model.
*
* @code
@@ -99,7 +99,7 @@ struct vlc_diffutil_insert {
/**
- * The data positionned at oldModel[ y ] is removed at position index
+ * The data positioned at oldModel[ y ] is removed at position index
* in the current model.
*
* @code
@@ -168,13 +168,13 @@ typedef struct {
typedef struct VLC_VECTOR(vlc_diffutil_change_t) vlc_diffutil_changelist_t;
enum vlc_diffutil_result_flag {
- /// try to transform an insertion with a matching supression into a move operation
+ /// try to transform an insertion with a matching suppression into a move operation
VLC_DIFFUTIL_RESULT_MOVE = 0x1,
/**
- * aggreate similar consecutive operations into a single operation
+ * aggregate similar consecutive operations into a single operation
* for instance this:
* [{INSERT, i=5}{INSERT, x=6}{REMOVE, i=10}{REMOVE, i=10}{REMOVE, i=10}]
- * would be tranformed into:
+ * would be transformed into:
* [{INSERT, i=5, count=2}{REMOVE, i=10, count=3}]
*/
VLC_DIFFUTIL_RESULT_AGGREGATE = 0x2,
=====================================
include/vlc_es_out.h
=====================================
@@ -90,7 +90,7 @@ enum es_out_query_e
/* Stop any buffering being done, and ask if es_out has no more data to
* play.
- * It will not block and so MUST be used carrefully. The only good reason
+ * It will not block and so MUST be used carefully. The only good reason
* is for interactive playback (like for DVD menu).
* XXX You SHALL call ES_OUT_RESET_PCR before any other es_out_Control/Send calls. */
ES_OUT_GET_EMPTY, /* arg1=bool* res=cannot fail */
=====================================
include/vlc_http.h
=====================================
@@ -89,7 +89,7 @@ VLC_API bool vlc_http_cookies_store( vlc_http_cookie_jar_t *jar,
* Returns a cookie value that match the given URL.
*
* @param jar a cookie jar
- * @param secure whether a secure connexion will be used or not
+ * @param secure whether a secure connection will be used or not
* @param host the hostname for which the cookie was stored
* @param path the cookie name to fetch
* @return A string consisting of semicolon-separated cookie NAME=VALUE pairs.
=====================================
include/vlc_httpd.h
=====================================
@@ -78,7 +78,7 @@ typedef struct
typedef struct httpd_message_t
{
- httpd_client_t *cl; /* NULL if not throught a connection e vlc internal */
+ httpd_client_t *cl; /* NULL if not through a connection e vlc internal */
uint8_t i_type;
uint8_t i_proto;
=====================================
include/vlc_intf_strings.h
=====================================
@@ -29,7 +29,7 @@
*/
/* A helper macro that will expand to either of the arguments
- depanding on platform. The arguments are supposed to be:
+ depending on platform. The arguments are supposed to be:
1. dir: a string containing "directory"
2. folder: a string with the same meaning but with directory
substituted with "folder"
=====================================
include/vlc_sout.h
=====================================
@@ -292,7 +292,7 @@ struct sout_stream_t
*
* \param parent The parent object of the stream output.
* \param config A valid config chain of the object, of the form
- * "objname{option=*,otion=*,...}"
+ * "objname{option=*,option=*,...}"
*
* \retval An empty allocated Stream Output object.
* \retval NULL on allocation error.
=====================================
include/vlc_stream.h
=====================================
@@ -159,8 +159,8 @@ struct stream_t
*
* Callback to read data from the stream into a caller-supplied buffer.
*
- * This is the legacy implementor, using \ref vlc_stream_operations
- * should be prefered.
+ * This is the legacy implementer, using \ref vlc_stream_operations
+ * should be preferred.
*
* This may be NULL if the stream is actually a directory rather than a
* byte stream, or if \ref stream_t.pf_block is non-NULL.
@@ -183,8 +183,8 @@ struct stream_t
* for buffers. In such case, this callback should be provided instead of
* \ref stream_t.pf_read; otherwise, this should be NULL.
*
- * This is the legacy implementor, using \ref vlc_stream_operations
- * should be prefered.
+ * This is the legacy implementer, using \ref vlc_stream_operations
+ * should be preferred.
*
* \param eof storage space for end-of-stream flag [OUT]
* (*eof is always false when invoking pf_block(); pf_block() should set
@@ -201,8 +201,8 @@ struct stream_t
* Callback to fill an item node from a directory
* (see doc/browsing.txt for details).
*
- * This is the legacy implementor, using \ref vlc_stream_operations
- * should be prefered.
+ * This is the legacy implementer, using \ref vlc_stream_operations
+ * should be preferred.
*
* NULL if the stream is not a directory.
*/
@@ -215,8 +215,8 @@ struct stream_t
*
* Callback to set the stream pointer (in bytes from start).
*
- * This is the legacy implementor, using \ref vlc_stream_operations
- * should be prefered.
+ * This is the legacy implementer, using \ref vlc_stream_operations
+ * should be preferred.
*
* May be NULL if seeking is not supported.
*/
@@ -226,7 +226,7 @@ struct stream_t
* Stream control.
*
* Legacy way of implementing callbacks.
- * \ref vlc_stream_operations should be prefered.
+ * \ref vlc_stream_operations should be preferred.
*
* \see stream_query_e
*/
=====================================
include/vlc_url.h
=====================================
@@ -67,7 +67,7 @@ VLC_API char *vlc_uri2path(const char *url) VLC_MALLOC;
* \warning <b>This function does NOT decode entire URIs.</b>
* URI can only be decoded (and encoded) one component at a time
* (e.g. the host name, one directory, the file name).
- * Complete URIs are always "encoded" (or they are syntaxically invalid).
+ * Complete URIs are always "encoded" (or they are syntactically invalid).
* See IETF RFC3986, especially §2.4 for details.
*
* \note URI encoding is <b>different</b> from Javascript escaping. Especially,
=====================================
include/vlc_vout_display.h
=====================================
@@ -423,7 +423,7 @@ VLC_API void vout_display_Delete(vout_display_t *);
*
* \bug Currently, only one picture can be prepared at a time. It must be
* displayed with vout_display_Display() before any picture is prepared or
- * before the display is destroyd with vout_display_Delete().
+ * before the display is destroyed with vout_display_Delete().
*
\ bug Rendering subpictures is not supported with this function yet.
* \c subpic must be @c NULL .
View it on GitLab: https://code.videolan.org/videolan/vlc/-/commit/d79286ac9b05785f212c52f6cc1a93b1080a1b1f
--
View it on GitLab: https://code.videolan.org/videolan/vlc/-/commit/d79286ac9b05785f212c52f6cc1a93b1080a1b1f
You're receiving this email because of your account on code.videolan.org.
VideoLAN code repository instance
More information about the vlc-commits
mailing list