birb/birb

Add a doc check unit test and fix the issues it found

2 months ago, Gary Kramlich
76c83a79e528
Parents a44f8e0b0fca
Children 9d56e51eac1d
Add a doc check unit test and fix the issues it found

Testing Done:
Ran the unit tests.

Reviewed at https://reviews.imfreedom.org/r/3041/
3 files changed, 54 insertions(+), 0 deletions(-)
  • +20 -0
    birb/birbversion.h
  • +24 -0
    birb/reference/birb.toml.in
  • +10 -0
    birb/reference/meson.build
    • --- a/birb/birbversion.h Fri Feb 23 04:47:05 2024 -0600
    +++ b/birb/birbversion.h Wed Mar 20 22:54:47 2024 -0500
    @@ -64,6 +64,26 @@
    #endif
    /**
    + * BIRB_VERSION_MIN_REQUIRED:
    + *
    + * A macro that should be defined by the user prior to including the `birb.h`
    + * header.
    + *
    + * The definition should be one of the predefined Birb version macros:
    + * %BIRB_VERSION_0_1, %BIRB_VERSION_0_2, ...
    + *
    + * This macro defines the earliest version of Birb that the package is required
    + * to be able to compile against.
    + *
    + * If the compiler is configured to warn about the use of deprecated functions,
    + * then using functions that were deprecated in version
    + * %BIRB_VERSION_MIN_REQUIRED or earlier will cause warnings (but using
    + * functions deprecated in later releases will not).
    + *
    + * Since: 0.1
    + */
    +
    +/**
    * BIRB_VERSION_CUR_STABLE:
    *
    * A macro that evaluates to the current stable version of birb, in a format
    --- a/birb/reference/birb.toml.in Fri Feb 23 04:47:05 2024 -0600
    +++ b/birb/reference/birb.toml.in Wed Mar 20 22:54:47 2024 -0500
    @@ -39,3 +39,27 @@
    content_files = []
    content_images = []
    urlmap_file = "urlmap.js"
    +
    +[[object]]
    +pattern = "DEPRECATED_IN_*"
    +hidden = true
    +
    +[[object]]
    +name = "DEPRECATED_FOR"
    +hidden = true
    +
    +[[object]]
    +name = "UNAVAILABLE"
    +hidden = true
    +
    +[[object]]
    +name = "UNAVAILABLE_MACRO"
    +hidden = true
    +
    +[[object]]
    +name = "UNAVAILABLE_STATIC_INLINE"
    +hidden = true
    +
    +[[object]]
    +name = "UNAVAILABLE_TYPE"
    +hidden = true
    \ No newline at end of file
    --- a/birb/reference/meson.build Fri Feb 23 04:47:05 2024 -0600
    +++ b/birb/reference/meson.build Wed Mar 20 22:54:47 2024 -0500
    @@ -31,4 +31,14 @@
    install_dir : docs_dir,
    )
    +test('doc-check',
    + gidocgen,
    + args: [
    + 'check',
    + '--config', birb_gidocgen_toml,
    + birb_gir[0],
    + ],
    + depends: birb_gir[0],
    +)
    +
    doc_targets += birb_doc