Move from valadoc generation to GTK-Doc

This commit is contained in:
2017-11-30 15:32:17 +01:00
parent 8aad092c6f
commit 55fcb3cbf7
14 changed files with 1646 additions and 114 deletions

View File

@@ -18,6 +18,54 @@
#include "matrix-version.h"
/**
* SECTION:matrix-version
* @short_description: Library version information
* @title: Version information for the SDK
*
* Version information macros and functions for the Matrix GLib SDK
*/
/**
* MATRIX_GLIB_MAJOR_VERSION:
*
* The major version number of the Matrix.org GLib SDK.
*/
/**
* MATRIX_GLIB_MINOR_VERSION:
*
* The minor version number of the Matrix.org GLib SDK.
*/
/**
* MATRIX_GLIB_MICRO_VERSION:
*
* The micro (patch) version number of the Matrix.org GLib SDK.
*/
/**
* MATRIX_GLIB_CHECK_VERSION:
* @required_major: the required major version
* @required_minor: the required minor version
* @required_micro: the required micro version
*
* Macro to check that the Matrix.org GLib SDK being compiled against is compatible with the given
* version.
*
* Returns: TRUE if the required version is satisfied; FALSE otherwise.
*/
/**
* matrix_glib_check_version:
* @required_major: the required major version
* @required_minor: the required minor version
* @required_micro: the required micro version
*
* Check that the Matrix.org GLib SDK in use is compatible with the given version.
*
* Returns: TRUE if the required version is satisfied; FALSE otherwise.
*/
gboolean
matrix_glib_check_version(guint required_major,
guint required_minor,

View File

@@ -30,9 +30,9 @@ matrix_glib_check_version(guint required_major,
guint required_minor,
guint required_micro);
#define MATRIX_GLIB_CHECK_VERSION(major, minor, micro) \
(MATRIX_GLIB_MAJOR_VERSION > (major) || \
(MATRIX_GLIB_MAJOR_VERSION == (major) && MATRIX_GLIB_MINOR_VERSION > (minor)) || \
(MATRIX_GLIB_MAJOR_VERSION == (major) && MATRIX_GLIB_MINOR_VERSION == (minor) && MATRIX_GLIB_MICRO_VERSION >= (micro)))
#define MATRIX_GLIB_CHECK_VERSION(required_major, required_minor, required_micro) \
(MATRIX_GLIB_MAJOR_VERSION > (required_major) || \
(MATRIX_GLIB_MAJOR_VERSION == (required_major) && MATRIX_GLIB_MINOR_VERSION > (required_minor)) || \
(MATRIX_GLIB_MAJOR_VERSION == (required_major) && MATRIX_GLIB_MINOR_VERSION == (required_minor) && MATRIX_GLIB_MICRO_VERSION >= (required_micro)))
#endif /* __MATRIX_VERSION_H__ */