[vlc-commits] [Git][videolan/vlc][master] 3 commits: vlc_sout: fix documentation

[Steve Lhomme (@robUx4)]

Steve Lhomme pushed to branch master at VideoLAN / VLC


Commits:
abdaad4d by Alexandre Janniaux at 2023-11-03T09:20:43+00:00
vlc_sout: fix documentation

 - missing parameter name
 - \return on void function sout_StreamIdDel

- - - - -
f059918a by Alexandre Janniaux at 2023-11-03T09:20:43+00:00
vlc_objects: fix documentation

    include/vlc_objects.h:109: warning: The following parameter of
        vlc_object_create(vlc_object_t *p_this, size_t i_size) is not
        documented: parameter 'p_this'

- - - - -
5fd68e00 by Alexandre Janniaux at 2023-11-03T09:20:43+00:00
input_internal: fix variable name

    src/input/input_internal.h:312: warning: argument 'events_cb' of command @param is not found in the argument list of input_Create(vlc_object_t *p_parent, input_thread_events_cb event_cb, void *events_data, input_item_t *p_item, enum input_type type, input_resource_t *p_resource, vlc_renderer_item_t *p_renderer)
    src/input/input_internal.h:312: warning: The following parameter of input_Create(vlc_object_t *p_parent, input_thread_events_cb event_cb, void *events_data, input_item_t *p_item, enum input_type type, input_resource_t *p_resource, vlc_renderer_item_t *p_renderer) is not documented:
      parameter 'event_cb'

- - - - -


3 changed files:

- include/vlc_objects.h
- include/vlc_sout.h
- src/input/input_internal.h


Changes:

=====================================
include/vlc_objects.h
=====================================
@@ -105,11 +105,15 @@ struct libvlc_int_t
 /**
  * Allocates and initializes a vlc object.
  *
+ * The object will need to be released with ::vlc_object_release()
+ * before \p parent is released.
+ *
+ * @param parent A parent object to create the new object from
  * @param i_size object byte size
  *
  * @return the new object, or NULL on error.
  */
-VLC_API void *vlc_object_create( vlc_object_t *, size_t i_size) VLC_MALLOC VLC_USED;
+VLC_API void *vlc_object_create(vlc_object_t *parent, size_t i_size) VLC_MALLOC VLC_USED;
 
 /**
  * Drops the strong reference to an object.


=====================================
include/vlc_sout.h
=====================================
@@ -286,6 +286,7 @@ VLC_API sout_stream_t *sout_StreamChainNew(vlc_object_t *parent,
  *
  * The returned opaque identifier should be released by ::sout_StreamIdDel().
  *
+ * \param s
  * \param fmt A non-NULL es-format descriptor.
  * \param es_id A non-NULL unique string describing the ES. This string is
  *              guaranteed to be valid for the whole lifetime of the ES (at
@@ -297,20 +298,18 @@ VLC_API sout_stream_t *sout_StreamChainNew(vlc_object_t *parent,
  * \return An opaque pointer identifying the ES.
  * \retval NULL In case of error.
  */
-VLC_API void *sout_StreamIdAdd(sout_stream_t *,
+VLC_API void *sout_StreamIdAdd(sout_stream_t *s,
                                const es_format_t *fmt,
                                const char *es_id) VLC_USED;
 
 /**
  * Delete an ES from the stream output.
  *
+ * \param s
  * \param id An opaque pointer identifying the ES returned by
  * ::sout_StreamIdAdd().
- *
- * \return An opaque pointer identifying the ES.
- * \retval NULL In case of error.
  */
-VLC_API void sout_StreamIdDel(sout_stream_t *, void *id);
+VLC_API void sout_StreamIdDel(sout_stream_t *s, void *id);
 
 /**
  * Pass a \ref vlc_frame_t to the stream output.
@@ -321,13 +320,15 @@ VLC_API void sout_StreamIdDel(sout_stream_t *, void *id);
  * \warning Only single frames are expected through this call, for frame chains,
  * you'll have to call this for each frames.
  *
+ * \param s
  * \param id The ES identifier that sent the frame.
+ * \param f a frame that will be consumed (through vlc_frame_Release)
  *
  * \retval VLC_SUCCESS on success.
  * \retval VLC_EGENERIC on non-recoverable unspecific error cases.
  * \retval (-ERRNO) A negated errno value describing the error case.
  */
-VLC_API int sout_StreamIdSend(sout_stream_t *, void *id, vlc_frame_t *);
+VLC_API int sout_StreamIdSend(sout_stream_t *s, void *id, vlc_frame_t *f);
 
 /**
  * Signal a flush of an ES to the stream output.
@@ -335,9 +336,10 @@ VLC_API int sout_StreamIdSend(sout_stream_t *, void *id, vlc_frame_t *);
  * Flush is an optional control, if implemented, it will drop all the bufferized
  * data from ES and/or forward the Flush command to the next stream.
  *
+ * \param s
  * \param id An identifier of the ES to flush.
  */
-VLC_API void sout_StreamFlush(sout_stream_t *, void *id);
+VLC_API void sout_StreamFlush(sout_stream_t *s, void *id);
 
 /**
  * Signal a PCR update to the stream output.


=====================================
src/input/input_internal.h
=====================================
@@ -322,7 +322,7 @@ typedef void (*input_thread_events_cb)( input_thread_t *input,
  * \return a pointer to the spawned input thread
  */
 input_thread_t * input_Create( vlc_object_t *p_parent,
-                               input_thread_events_cb event_cb, void *events_data,
+                               input_thread_events_cb events_cb, void *events_data,
                                input_item_t *, enum input_type type,
                                input_resource_t *, vlc_renderer_item_t* p_renderer ) VLC_USED;
 #define input_Create(a,b,c,d,e,f,g) input_Create(VLC_OBJECT(a),b,c,d,e,f,g)



View it on GitLab: https://code.videolan.org/videolan/vlc/-/compare/fcc12de5197ff1bf9d7262518f55e73a922c0afe...5fd68e006497fc058478721a89eb681ca83b1dd4

-- 
View it on GitLab: https://code.videolan.org/videolan/vlc/-/compare/fcc12de5197ff1bf9d7262518f55e73a922c0afe...5fd68e006497fc058478721a89eb681ca83b1dd4
You're receiving this email because of your account on code.videolan.org.


VideoLAN code repository instance