libgnt/libgnt

Fix a bunch of issues with the docs.

2021-03-27, Gary Kramlich
89f1b7139a49
Parents 9d23268ff9c8
Children 81827d41b859
Fix a bunch of issues with the docs.

There's still three warnings but I'm having a hard time figuring out how to
fix them right now.

Testing Done:
Build the docs locally verified the warnings are gone.

Reviewed at https://reviews.imfreedom.org/r/586/
5 files changed, 45 insertions(+), 4 deletions(-)
  • +1 -1
    doc/libgnt-docs.xml
  • +4 -0
    doc/meson.build
  • +4 -0
    gntkeys.h
  • +2 -2
    gntmain.h
  • +34 -1
    gntversion.h.in
    • --- a/doc/libgnt-docs.xml Thu Feb 04 23:26:55 2021 -0600
    +++ b/doc/libgnt-docs.xml Sat Mar 27 03:27:04 2021 -0500
    @@ -27,10 +27,10 @@
    <part id="core">
    <title>Core API Reference</title>
    - <xi:include href="xml/gnt.xml" />
    <xi:include href="xml/gntversion.xml" />
    <xi:include href="xml/gntcolors.xml" />
    <xi:include href="xml/gntkeys.xml" />
    + <xi:include href="xml/gntmain.xml" />
    <xi:include href="xml/gntstyle.xml" />
    <xi:include href="xml/gntutils.xml" />
    </part>
    --- a/doc/meson.build Thu Feb 04 23:26:55 2021 -0600
    +++ b/doc/meson.build Sat Mar 27 03:27:04 2021 -0500
    @@ -9,12 +9,16 @@
    ignore_headers = [
    'test',
    'wms',
    + 'gnt.h',
    'gntinternal.h',
    'gnt-skel.h',
    'gntboxprivate.h',
    + 'gntconfig.h',
    'gntmainprivate.h',
    + 'gntmarshal.h',
    'gntmenuprivate.h',
    'gntmenuitemprivate.h',
    + 'gntncurses.h',
    'gntstyleprivate.h',
    'gnttreeprivate.h',
    'gntwidgetprivate.h',
    --- a/gntkeys.h Thu Feb 04 23:26:55 2021 -0600
    +++ b/gntkeys.h Sat Mar 27 03:27:04 2021 -0500
    @@ -46,11 +46,15 @@
    /**
    * GNT_KEY_SAFE: (skip)
    + * @x: A character.
    + *
    + * If @x is printable this evalutes to @x, otherwise "".
    */
    #define GNT_KEY_SAFE(x) ((cur_term && (x)) ? (x) : "")
    /**
    * GNT_KEY_CONSTCH: (skip)
    + * @x: A keycode string.
    *
    * This is needed so that g-ir-scanner does not take GNT_KEY_CTRL_* as
    * constants -- because if it does, the .gir contains the following invalid XML
    --- a/gntmain.h Thu Feb 04 23:26:55 2021 -0600
    +++ b/gntmain.h Sat Mar 27 03:27:04 2021 -0500
    @@ -27,8 +27,8 @@
    #define GNT_MAIN_H
    /**
    - * SECTION:gnt
    - * @section_id: libgnt-gnt
    + * SECTION:gntmain
    + * @section_id: libgnt-gntmain
    * @title: General
    * @short_description: General API for managing GNT
    */
    --- a/gntversion.h.in Thu Feb 04 23:26:55 2021 -0600
    +++ b/gntversion.h.in Sat Mar 27 03:27:04 2021 -0500
    @@ -32,10 +32,43 @@
    * @short_description: Variables to check the GNT version
    */
    +/**
    + * GNT_VERSION:
    + *
    + * The full version number. For example 2.14.0.
    + */
    #mesondefine GNT_VERSION
    +
    +/**
    + * GNT_MAJOR_VERSION:
    + *
    + * The major version number. For example, if the version is "2.14.0devel", this
    + * is the "2".
    + */
    #mesondefine GNT_MAJOR_VERSION
    +
    +/**
    + * GNT_MINOR_VERSION:
    + *
    + * The minor version number. For example, if the version is "2.14.0devel", this
    + * is the "14".
    + */
    #mesondefine GNT_MINOR_VERSION
    +
    +/**
    + * GNT_MICRO_VERSION:
    + *
    + * The micro version number. For example, if the version is "2.14.0devel", this
    + * is the "0".
    + */
    #mesondefine GNT_MICRO_VERSION
    +
    +/**
    + * GNT_EXTRA_VERSION:
    + *
    + * The extra part of the version. For example, if the version is "2.14.0devel"
    + * this is "devel".
    + */
    #mesondefine GNT_EXTRA_VERSION
    -#endif
    +#endif /* GNT_VERSION_H */