version: Add NICE_CHECK_VERSION to the documentation
authorOlivier Crête <olivier.crete@collabora.com>
Thu, 26 May 2022 18:23:31 +0000 (14:23 -0400)
committerOlivier Crête <olivier.crete@collabora.com>
Thu, 26 May 2022 18:23:31 +0000 (14:23 -0400)
docs/reference/libnice/libnice-sections.txt
docs/reference/libnice/meson.build
nice/nice.h

index 30044ba..ad94a34 100644 (file)
@@ -59,6 +59,7 @@ nice_agent_get_component_state
 nice_agent_close_async
 nice_agent_consent_lost
 nice_component_state_to_string
+NICE_CHECK_VERSION
 <SUBSECTION Standard>
 NICE_AGENT
 NICE_IS_AGENT
index 34bee96..04d24eb 100644 (file)
@@ -41,7 +41,7 @@ gnome.gtkdoc('libnice',
              main_xml: 'libnice-docs.xml',
              namespace: 'nice',
              mode: 'none',
-             src_dir: [agent_include, stun_include],
+             src_dir: [agent_include, stun_include, nice_include],
              content_files: fake_makefile,
              dependencies: libnice_dep,
              scan_args: [
index 74a7e74..edad400 100644 (file)
 
 #include "nice-version.h"
 
+/**
+ * NICE_CHECK_VERSION:
+ * @major: The major numbe of the version
+ * @minor: The major numbe of the version
+ * @micro: The major numbe of the version
+ *
+ * Macro that returns TRUE if the version if libnice that you are compiling
+ * against is greater or equal to the argument
+ *
+ * Since: 0.1.20
+ */
+
 #define NICE_CHECK_VERSION(major, minor, micro)                         \
     (NICE_VERSION_MAJOR > (major) ||                                    \
      (NICE_VERSION_MAJOR == (major) && NICE_VERSION_MINOR > (minor)) || \