[vlc-commits] [Git][videolan/vlc][master] include: use \copydoc where suitable

[Steve Lhomme (@robUx4)]

Steve Lhomme pushed to branch master at VideoLAN / VLC


Commits:
33f6724f by Alexandre Janniaux at 2026-09-02T09:08:28+00:00
include: use \copydoc where suitable

By using \copydoc, we have a free reference to the operation table
operation as well as the proper documentation without duplication.

- - - - -


5 changed files:

- include/vlc_filter.h
- include/vlc_opengl_sampler.h
- include/vlc_preparser_ipc.h
- include/vlc_vout_display.h
- include/vlc_window.h


Changes:

=====================================
include/vlc_filter.h
=====================================
@@ -280,9 +280,7 @@ static inline picture_t *filter_NewPicture( filter_t *p_filter )
 }
 
 /**
- * Flush a filter
- *
- * This function will flush the state of a filter (audio or video).
+ * \copydoc vlc_filter_operations::flush
  */
 static inline void filter_Flush( filter_t *p_filter )
 {
@@ -290,6 +288,9 @@ static inline void filter_Flush( filter_t *p_filter )
         p_filter->ops->flush( p_filter );
 }
 
+/**
+ * \copydoc vlc_filter_operations::change_viewpoint
+ */
 static inline void filter_ChangeViewpoint( filter_t *p_filter,
                                            const vlc_viewpoint_t *vp)
 {


=====================================
include/vlc_opengl_sampler.h
=====================================
@@ -192,18 +192,27 @@ struct vlc_gl_sampler {
     void *sys;
 };
 
+/**
+ * \copydoc vlc_gl_sampler_ops::fetch_locations
+ */
 static inline void
 vlc_gl_sampler_FetchLocations(struct vlc_gl_sampler *sampler, uint32_t program)
 {
     sampler->ops->fetch_locations(sampler, program);
 }
 
+/**
+ * \copydoc vlc_gl_sampler_ops::load
+ */
 static inline void
 vlc_gl_sampler_Load(struct vlc_gl_sampler *sampler)
 {
     sampler->ops->load(sampler);
 }
 
+/**
+ * \copydoc vlc_gl_sampler_ops::update
+ */
 static inline int
 vlc_gl_sampler_Update(struct vlc_gl_sampler *sampler,
                       const struct vlc_gl_picture *picture)
@@ -211,6 +220,9 @@ vlc_gl_sampler_Update(struct vlc_gl_sampler *sampler,
     return sampler->ops->update(sampler, picture);
 }
 
+/**
+ * \copydoc vlc_gl_sampler_ops::select_plane
+ */
 static inline void
 vlc_gl_sampler_SelectPlane(struct vlc_gl_sampler *sampler, unsigned plane)
 {


=====================================
include/vlc_preparser_ipc.h
=====================================
@@ -265,13 +265,7 @@ typedef int (*vlc_preparser_msg_serdes_module)
     set_capability("preparser msg serdes", priority)
 
 /**
- * Call the serialize operation.
- *
- * @param [in]  s
- * @param [out] buf
- * @param [in]  msg
- *
- * @return      size of the allocated buffer.
+ * \copydoc vlc_preparser_msg_serdes_operations::serialize
  */
 static inline int
 vlc_preparser_msg_serdes_Serialize(struct vlc_preparser_msg_serdes *serdes,
@@ -287,13 +281,7 @@ vlc_preparser_msg_serdes_Serialize(struct vlc_preparser_msg_serdes *serdes,
 }
 
 /**
- * Call the deserialize operation.
- *
- * @param [in]  s
- * @param [in]  buf
- * @param [in]  size
- *
- * @return      size of the allocated buffer.
+ * \copydoc vlc_preparser_msg_serdes_operations::deserialize
  */
 static inline int
 vlc_preparser_msg_serdes_Deserialize(struct vlc_preparser_msg_serdes *serdes,


=====================================
include/vlc_vout_display.h
=====================================
@@ -478,7 +478,7 @@ VLC_API picture_t *vout_display_Prepare(vout_display_t *vd, picture_t *picture,
                                         const struct vlc_render_subpicture *subpic, vlc_tick_t date);
 
 /**
- * Displays a picture.
+ * \copydoc vlc_display_operations::display
  */
 static inline void vout_display_Display(vout_display_t *vd, picture_t *picture)
 {
@@ -542,11 +542,17 @@ static inline bool vout_display_cfg_IsWindowed(const vout_display_cfg_t *cfg)
     return cfg->window->type != VLC_WINDOW_TYPE_DUMMY;
 }
 
-static inline int vout_display_ChangeProjection(vout_display_t *vd, video_projection_mode_t projection)
+/**
+ * \copydoc vlc_display_operations::change_source_projection
+ *
+ * \retval VLC_ENOTSUP the display does not implement projection changes
+ */
+static inline int vout_display_ChangeProjection(vout_display_t *display,
+                                                video_projection_mode_t projection)
 {
-    if (vd->ops->change_source_projection == NULL)
+    if (display->ops->change_source_projection == NULL)
         return VLC_ENOTSUP;
-    return vd->ops->change_source_projection(vd, projection);
+    return display->ops->change_source_projection(display, projection);
 }
 
 /**


=====================================
include/vlc_window.h
=====================================
@@ -645,6 +645,9 @@ VLC_API void vlc_window_ReportWindowed(vlc_window_t *wnd);
  */
 VLC_API void vlc_window_ReportFullscreen(vlc_window_t *wnd, const char *id);
 
+/**
+ * \copydoc vlc_window_callbacks::mouse_event
+ */
 static inline void vlc_window_SendMouseEvent(vlc_window_t *window,
                                               const vlc_window_mouse_event_t *mouse)
 {



View it on GitLab: https://code.videolan.org/videolan/vlc/-/commit/33f6724f781105adf78330d468dd5a45bf2cc0cc

-- 
View it on GitLab: https://code.videolan.org/videolan/vlc/-/commit/33f6724f781105adf78330d468dd5a45bf2cc0cc
You're receiving this email because of your account on code.videolan.org. Manage all notifications: https://code.videolan.org/-/profile/notifications | Help: https://code.videolan.org/help