hasl/hasl

Add a test to run `gi-docgen check` and fix the issues it found
default tip
7 weeks ago, Gary Kramlich
24a2c23b96f6
Parents 4312c9db8c1f
Children
Add a test to run `gi-docgen check` and fix the issues it found

Testing Done:
Ran the unit tests.

Reviewed at https://reviews.imfreedom.org/r/3038/
5 files changed, 55 insertions(+), 4 deletions(-)
  • +1 -1
    hasl/haslgs2header.c
  • +4 -3
    hasl/haslmechanism.h
  • +20 -0
    hasl/haslversion.h
  • +20 -0
    hasl/reference/hasl.toml.in
  • +10 -0
    hasl/reference/meson.build
    • --- a/hasl/haslgs2header.c Thu Feb 29 22:16:22 2024 -0600
    +++ b/hasl/haslgs2header.c Wed Mar 20 22:33:23 2024 -0500
    @@ -141,7 +141,7 @@
    G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
    /**
    - * HalsGs2Header:channel-binding:
    + * HaslGs2Header:channel-binding:
    *
    * The channel binding flag for this header.
    *
    --- a/hasl/haslmechanism.h Thu Feb 29 22:16:22 2024 -0600
    +++ b/hasl/haslmechanism.h Wed Mar 20 22:33:23 2024 -0500
    @@ -44,9 +44,10 @@
    /**
    * HaslMechanismResult:
    - * @success: The mechanism completed successfully.
    - * @continue: The mechanism has additional steps to perform.
    - * @error: The mechanism encountered an error.
    + * @HASL_MECHANISM_RESULT_SUCCESS: The mechanism completed successfully.
    + * @HASL_MECHANISM_RESULT_CONTINUE: The mechanism has additional steps to
    + * perform.
    + * @HASL_MECHANISM_RESULT_ERROR: The mechanism encountered an error.
    *
    * The result states for [method@Hasl.Mechanism.step].
    *
    --- a/hasl/haslversion.h Thu Feb 29 22:16:22 2024 -0600
    +++ b/hasl/haslversion.h Wed Mar 20 22:33:23 2024 -0500
    @@ -45,6 +45,26 @@
    #define _HASL_EXTERN _HASL_API extern
    +/**
    + * HASL_VERSION_MIN_REQUIRED:
    + *
    + * A macro that should be defined by the user prior to including the `hasl.h`
    + * header.
    + *
    + * The definition should be one of the predefined Hasl version macros:
    + * %HASL_VERSION_0_2, %HASL_VERSION_0_3, ...
    + *
    + * This macro defines the earliest version of Hasl 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
    + * %HASL_VERSION_MIN_REQUIRED or earlier will cause warnings (but using
    + * functions deprecated in later releases will not).
    + *
    + * Since: 0.3
    + */
    +
    #ifdef HASL_DISABLE_DEPRECATION_WARNINGS
    #define HASL_DEPRECATED _HASL_EXTERN
    #define HASL_DEPRECATED_FOR(f) _HASL_EXTERN
    --- a/hasl/reference/hasl.toml.in Thu Feb 29 22:16:22 2024 -0600
    +++ b/hasl/reference/hasl.toml.in Wed Mar 20 22:33:23 2024 -0500
    @@ -34,3 +34,23 @@
    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_STATIC_INLINE"
    +hidden = true
    +
    +[[object]]
    +name = "UNAVAILABLE_TYPE"
    +hidden = true
    --- a/hasl/reference/meson.build Thu Feb 29 22:16:22 2024 -0600
    +++ b/hasl/reference/meson.build Wed Mar 20 22:33:23 2024 -0500
    @@ -31,4 +31,14 @@
    install_dir : docs_dir,
    )
    +test('doc-check',
    + gidocgen,
    + args: [
    + 'check',
    + '--config', hasl_gidocgen_toml,
    + hasl_gir[0],
    + ],
    + depends: hasl_gir[0],
    +)
    +
    doc_targets += hasl_doc