[libbluray-devel] [Git][videolan/libbluray][master] 3 commits: Add installed headers to doxygen

[Petri Hintukainen (@hpi)]

Petri Hintukainen pushed to branch master at VideoLAN / libbluray


Commits:
e402af5c by Petri Hintukainen at 2022-09-24T10:48:26+03:00
Add installed headers to doxygen

- - - - -
e3d94126 by Petri Hintukainen at 2022-09-24T10:48:26+03:00
Add brief (doxygen) description to public headers

- - - - -
62b17512 by Petri Hintukainen at 2022-09-24T17:31:08+03:00
Use doxygen tag to mark deprecated functions

- - - - -


10 changed files:

- doc/doxygen-config
- src/file/filesystem.h
- src/libbluray/bdnav/clpi_data.h
- src/libbluray/bdnav/meta_data.h
- src/libbluray/bluray-version.h.in
- src/libbluray/bluray.h
- src/libbluray/decoders/overlay.h
- src/libbluray/keys.h
- src/libbluray/player_settings.h
- src/util/log_control.h


Changes:

=====================================
doc/doxygen-config
=====================================
@@ -780,7 +780,15 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  = src/libbluray/bluray.h
+INPUT                  = \
+    src/libbluray/bluray.h \
+    src/libbluray/bluray-version.h \
+    src/file/filesystem.h \
+    src/libbluray/keys.h \
+    src/util/log_control.h \
+    src/libbluray/bdnav/meta_data.h \
+    src/libbluray/decoders/overlay.h \
+    src/libbluray/player_settings.h
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses


=====================================
src/file/filesystem.h
=====================================
@@ -18,6 +18,11 @@
  * <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @file
+ * \brief Filesystem interface
+ */
+
 #ifndef BD_FILESYSTEM_H_
 #define BD_FILESYSTEM_H_
 
@@ -65,23 +70,23 @@ typedef BD_FILE_H* (*BD_FILE_OPEN)(const char* filename, const char *mode);
 typedef BD_DIR_H* (*BD_DIR_OPEN) (const char* dirname);
 
 /**
- *
  *  Register function pointer that will be used to open a file
  *
+ * @deprecated Use bd_open_files() instead.
+ *
  * @param p function pointer
  * @return previous function pointer registered
  */
-/* deprecated - use bd_open_files() instead */
 BD_FILE_OPEN bd_register_file(BD_FILE_OPEN p);
 
 /**
- *
  *  Register function pointer that will be used to open a directory
  *
+ * @deprecated Use bd_open_files() instead.
+ *
  * @param p function pointer
  * @return previous function pointer registered
  */
-/* deprecated - use bd_open_files() instead */
 BD_DIR_OPEN bd_register_dir(BD_DIR_OPEN p);
 
 #ifdef __cplusplus


=====================================
src/libbluray/bdnav/clpi_data.h
=====================================
@@ -18,6 +18,11 @@
  * <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @file
+ * \brief CLPI (Clip Information) file data
+ */
+
 #if !defined(_CLPI_DATA_H_)
 #define _CLPI_DATA_H_
 


=====================================
src/libbluray/bdnav/meta_data.h
=====================================
@@ -20,6 +20,11 @@
 #if !defined(_META_DATA_H_)
 #define _META_DATA_H_
 
+/**
+ * @file
+ * \brief Disc metadata definitions
+ */
+
 #include <stdint.h>
 
 typedef struct meta_thumbnail {


=====================================
src/libbluray/bluray-version.h.in
=====================================
@@ -17,6 +17,11 @@
  * <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @file
+ * \brief libbluray API version
+ */
+
 #ifndef BLURAY_VERSION_H_
 #define BLURAY_VERSION_H_
 


=====================================
src/libbluray/bluray.h
=====================================
@@ -19,6 +19,11 @@
  * <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @file
+ * \brief libbluray API
+ */
+
 #ifndef BLURAY_H_
 #define BLURAY_H_
 
@@ -26,11 +31,6 @@
 extern "C" {
 #endif
 
-/**
- * @file libbluray/bluray.h
- * external API header
- */
-
 #include <stdint.h>
 
 #define TITLES_ALL              0    /**< all titles. */


=====================================
src/libbluray/decoders/overlay.h
=====================================
@@ -17,6 +17,11 @@
  * <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @file
+ * \brief Graphics overlay events
+ */
+
 #ifndef BD_OVERLAY_H_
 #define BD_OVERLAY_H_
 


=====================================
src/libbluray/keys.h
=====================================
@@ -17,6 +17,11 @@
  * <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @file
+ * \brief User input key definitions
+ */
+
 #if !defined(_BD_KEYS_H_)
 #define _BD_KEYS_H_
 


=====================================
src/libbluray/player_settings.h
=====================================
@@ -17,6 +17,11 @@
  * <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @file
+ * \brief Definitions for Blu-Ray player settings
+ */
+
 #ifndef BD_PLAYER_SETTINGS_H_
 #define BD_PLAYER_SETTINGS_H_
 


=====================================
src/util/log_control.h
=====================================
@@ -18,6 +18,11 @@
  * <http://www.gnu.org/licenses/>.
  */
 
+/**
+ * @file
+ * \brief Log control and capture
+ */
+
 #ifndef BD_LOG_CONTROL_H_
 #define BD_LOG_CONTROL_H_
 



View it on GitLab: https://code.videolan.org/videolan/libbluray/-/compare/926cdf19ebfe63a934306132cf776128cab5e083...62b1751287eb9e4e1a9936009dea6ed798beacfb

-- 
View it on GitLab: https://code.videolan.org/videolan/libbluray/-/compare/926cdf19ebfe63a934306132cf776128cab5e083...62b1751287eb9e4e1a9936009dea6ed798beacfb
You're receiving this email because of your account on code.videolan.org.


VideoLAN code repository instance