[vlc-devel] commit: Document vlc_custom_create. ( Rémi Denis-Courmont )

[git version control]

vlc | branch: master | Rémi Denis-Courmont <rem at videolan.org> | Tue Mar 25 23:08:20 2008 +0200| [7b7d2516fcb4a501a923557ca1f9ffb5f1c77ccd]

Document vlc_custom_create.

> http://git.videolan.org/gitweb.cgi/vlc.git/?a=commit;h=7b7d2516fcb4a501a923557ca1f9ffb5f1c77ccd
---

 src/libvlc.h |   14 ++++++++++++++
 1 files changed, 14 insertions(+), 0 deletions(-)

diff --git a/src/libvlc.h b/src/libvlc.h
index fb1e598..046f0f4 100644
--- a/src/libvlc.h
+++ b/src/libvlc.h
@@ -71,6 +71,20 @@ uint32_t CPUCapabilities( void );
  * LibVLC objects stuff
  */
 
+/**
+ * Creates a VLC object.
+ *
+ * Note that because the object name pointer must remain valid, potentially
+ * even after the destruction of the object (through the message queues), this
+ * function CANNOT be exported to plugins as is. In this case, the old
+ * vlc_object_create() must be used instead.
+ *
+ * @param p_this an existing VLC object
+ * @param i_size byte size of the object structure
+ * @param i_type object type, usually VLC_OBJECT_CUSTOM
+ * @param psz_type object type name
+ * @return the created object, or NULL.
+ */
 extern vlc_object_t *
 vlc_custom_create (vlc_object_t *p_this, size_t i_size, int i_type,
                    const char *psz_type);