- * Return the libvlc internal object, the main object that all other depend on.
- * Any of of this function should be considered an ugly hack and avoided at all
- * cost. E.g. you need to expose some functionality that is not provided by the
- * libvlc API directly with libvlccore.
- * Remember to release the object with vlc_object_release( obj* )
+ * Get the internal main VLC object.
+ * Use of this function is usually a hack and should be avoided.
+ * @note
+ * You will need to link with libvlccore to make any use of the underlying VLC
+ * object. The libvlccore programming and binary interfaces are not stable.
+ * @warning
+ * Remember to release the object with vlc_object_release().