gplugin/gplugin

Update the version api reference
feature/gtk-doc
2017-07-31, Gary Kramlich
6fde5782dcac
Parents 30f9ec0c2972
Children bf6388cee6ac
Update the version api reference
2 files changed, 59 insertions(+), 4 deletions(-)
  • +55 -0
    gplugin/gplugin-version.c
  • +4 -4
    gplugin/gplugin-version.h.in
    • --- a/gplugin/gplugin-version.c Mon Jul 31 21:45:35 2017 -0500
    +++ b/gplugin/gplugin-version.c Mon Jul 31 22:04:12 2017 -0500
    @@ -15,6 +15,17 @@
    * License along with this library; if not, see <http://www.gnu.org/licenses/>.
    */
    +/**
    + * SECTION:gplugin-version
    + * @Title: Version Information
    + * @Short_description: variables and functions to check the GPlugin version
    + *
    + *
    + * GPlugin provides version information, primarily useful in configure
    + * checks for builds that have a configure script. Applications will
    + * not typically use the features described here.
    + */
    +
    #include <gplugin/gplugin-core.h>
    #include <gplugin/gplugin-version.h>
    @@ -105,6 +116,50 @@
    /******************************************************************************
    * GPluginVersion API
    *****************************************************************************/
    +
    +/**
    + * GPLUGIN_MAJOR_VERSION:
    + *
    + * This is the major version number of GPlugin that was compiled against.
    + */
    +
    +/**
    + * GPLUGIN_MINOR_VERSION:
    + *
    + * This is the minor version number of GPlugin that was compiled against.
    + */
    +
    +/**
    + * GPLUGIN_MICRO_VERSION:
    + *
    + * This is the micro version number of GPlugin that was compiled against.
    + */
    +
    +/**
    + * GPLUGIN_EXTRA_VERSION:
    + *
    + * This is the extra version string of GPlugin that was compiled against.
    + */
    +
    +/**
    + * GPLUGIN_VERSION:
    + *
    + * This is the string version number of GPlugin that was compiled against.
    + */
    +
    +/**
    + * GPLUGIN_VERSION_CHECK:
    + * @major: the major version to check for
    + * @minor: the minor version to check for
    + * @micro: the micro version to check for
    + *
    + * Checks the version of the GPlugin library that is being compiled
    + * against. See gplugin_check_version() for a runtime check.
    + *
    + * Returns: %TRUE if the version of the GPlugin header files
    + * is the same as or newer than the passed-in version.
    + */
    +
    /**
    * GPluginVersionCompareFunc:
    * @v1: The first version to compare
    --- a/gplugin/gplugin-version.h.in Mon Jul 31 21:45:35 2017 -0500
    +++ b/gplugin/gplugin-version.h.in Mon Jul 31 22:04:12 2017 -0500
    @@ -30,10 +30,10 @@
    #define GPLUGIN_VERSION "@GPLUGIN_VERSION@"
    -#define GPLUGIN_VERSION_CHECK(x,y,z) \
    - ((x) == GPLUGIN_MAJOR_VERSION && \
    - ((y) < GPLUGIN_MINOR_VERSION || \
    - ((y) == GPLUGIN_MINOR_VERSION && (z) <= GPLUGIN_MICRO_VERSION)))
    +#define GPLUGIN_VERSION_CHECK(major,minor,micro) \
    + ((major) == GPLUGIN_MAJOR_VERSION && \
    + ((minor) < GPLUGIN_MINOR_VERSION || \
    + ((minor) == GPLUGIN_MINOR_VERSION && (micro) <= GPLUGIN_MICRO_VERSION)))
    #include <glib.h>