diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/Doxyfile.in | 3 | ||||
| -rw-r--r-- | doc/conf.py.in | 4 | ||||
| -rw-r--r-- | doc/html/meson.build | 15 | ||||
| -rw-r--r-- | doc/meson.build | 3 | ||||
| -rw-r--r-- | doc/overview_code.c | 21 | ||||
| -rw-r--r-- | doc/singlehtml/meson.build | 15 | ||||
| -rw-r--r-- | doc/xml/meson.build | 8 |
7 files changed, 39 insertions, 30 deletions
diff --git a/doc/Doxyfile.in b/doc/Doxyfile.in index cce012f..0c60cab 100644 --- a/doc/Doxyfile.in +++ b/doc/Doxyfile.in @@ -37,6 +37,7 @@ PREDEFINED = ZIX_ALLOCATED= \ ZIX_END_DECLS= \ ZIX_MALLOC_API= \ ZIX_MALLOC_FUNC= \ + ZIX_NODISCARD= \ ZIX_NONNULL= \ ZIX_NULLABLE= \ ZIX_PURE_API= \ @@ -67,5 +68,7 @@ INPUT = @ZIX_SRCDIR@/include/zix/zix.h \ \ @ZIX_SRCDIR@/include/zix/filesystem.h \ @ZIX_SRCDIR@/include/zix/path.h \ + \ + @ZIX_SRCDIR@/include/zix/environment.h \ OUTPUT_DIRECTORY = @DOX_OUTPUT@ diff --git a/doc/conf.py.in b/doc/conf.py.in index 6b3c415..a7c254d 100644 --- a/doc/conf.py.in +++ b/doc/conf.py.in @@ -1,10 +1,10 @@ -# Copyright 2021-2023 David Robillard <d@drobilla.net> +# Copyright 2021-2025 David Robillard <d@drobilla.net> # SPDX-License-Identifier: 0BSD OR ISC # Project information project = "Zix" -copyright = "2011-2023, David Robillard" +copyright = "2011-2025, David Robillard" author = "David Robillard" release = "@ZIX_VERSION@" version = "@ZIX_VERSION@" diff --git a/doc/html/meson.build b/doc/html/meson.build index 9c0da44..45374d3 100644 --- a/doc/html/meson.build +++ b/doc/html/meson.build @@ -6,12 +6,15 @@ html_dir = docdir / versioned_name / 'html' custom_target( 'html', build_by_default: true, - command: sphinx_build_command + [ - '-b', 'html', - '-t', 'html', - sphinx_in_dir, - '@OUTDIR@', - ], + command: ( + sphinx_build_command + + [ + '-b', 'html', + '-t', 'html', + sphinx_in_dir, + '@OUTDIR@', + ] + ), input: [api_zix_rst, conf_py, sphinx_input], install: true, install_dir: html_dir, diff --git a/doc/meson.build b/doc/meson.build index 6d60bbb..d48f120 100644 --- a/doc/meson.build +++ b/doc/meson.build @@ -37,8 +37,9 @@ if build_docs executable( 'overview_code', files('overview_code.c'), - dependencies: [zix_dep], c_args: c_suppressions, + dependencies: [zix_dep], + implicit_include_directories: false, ), suite: 'doc', ) diff --git a/doc/overview_code.c b/doc/overview_code.c index 2f6a099..063f829 100644 --- a/doc/overview_code.c +++ b/doc/overview_code.c @@ -1,4 +1,4 @@ -// Copyright 2021-2023 David Robillard <d@drobilla.net> +// Copyright 2021-2024 David Robillard <d@drobilla.net> // SPDX-License-Identifier: ISC /* @@ -8,13 +8,8 @@ written such that it at least compiles and will run without crashing. */ -#include "zix/attributes.h" -#include "zix/string_view.h" - -#if defined(__GNUC__) -# pragma GCC diagnostic push -# pragma GCC diagnostic ignored "-Wunused-variable" -#endif +#include <zix/attributes.h> +#include <zix/string_view.h> static void string_views(void) @@ -24,6 +19,7 @@ string_views(void) // begin make-empty-string ZixStringView empty = zix_empty_string(); // end make-empty-string + (void)empty; // begin make-static-string static const ZixStringView hello = ZIX_STATIC_STRING("hello"); @@ -33,20 +29,17 @@ string_views(void) // begin measure-string ZixStringView view = zix_string(string_pointer); // end measure-string + (void)view; // begin make-string-view ZixStringView slice = zix_substring(string_pointer, 4); // end make-string-view + (void)slice; } -ZIX_CONST_FUNC -int +ZIX_CONST_FUNC int main(void) { string_views(); return 0; } - -#if defined(__GNUC__) -# pragma GCC diagnostic pop -#endif diff --git a/doc/singlehtml/meson.build b/doc/singlehtml/meson.build index 33bff61..32a8201 100644 --- a/doc/singlehtml/meson.build +++ b/doc/singlehtml/meson.build @@ -6,12 +6,15 @@ singlehtml_dir = docdir / versioned_name / 'singlehtml' custom_target( 'singlehtml', build_by_default: true, - command: sphinx_build_command + [ - '-b', 'singlehtml', - '-t', 'singlehtml', - sphinx_in_dir, - '@OUTDIR@', - ], + command: ( + sphinx_build_command + + [ + '-b', 'singlehtml', + '-t', 'singlehtml', + sphinx_in_dir, + '@OUTDIR@', + ] + ), input: [api_zix_rst, conf_py, sphinx_input], install: true, install_dir: singlehtml_dir, diff --git a/doc/xml/meson.build b/doc/xml/meson.build index b8863f3..f5a6b1d 100644 --- a/doc/xml/meson.build +++ b/doc/xml/meson.build @@ -23,6 +23,7 @@ doxygen_xml = custom_target( 'btree_8h.xml', 'bump__allocator_8h.xml', 'digest_8h.xml', + 'environment_8h.xml', 'filesystem_8h.xml', 'group__bump__allocator.xml', 'group__zix.xml', @@ -35,8 +36,11 @@ doxygen_xml = custom_target( 'group__zix__btree__modification.xml', 'group__zix__btree__searching.xml', 'group__zix__btree__setup.xml', + 'group__zix__btree__types.xml', 'group__zix__data__structures.xml', 'group__zix__digest.xml', + 'group__zix__environment.xml', + 'group__zix__expand.xml', 'group__zix__file__system.xml', 'group__zix__fs__access.xml', 'group__zix__fs__creation.xml', @@ -46,11 +50,11 @@ doxygen_xml = custom_target( 'group__zix__fs__queries.xml', 'group__zix__fs__resolution.xml', 'group__zix__hash.xml', - 'group__zix__hash__datatypes.xml', 'group__zix__hash__iteration.xml', 'group__zix__hash__modification.xml', 'group__zix__hash__searching.xml', 'group__zix__hash__setup.xml', + 'group__zix__hash__types.xml', 'group__zix__path.xml', 'group__zix__path__concatenation.xml', 'group__zix__path__decomposition.xml', @@ -59,6 +63,7 @@ doxygen_xml = custom_target( 'group__zix__ring.xml', 'group__zix__ring__read.xml', 'group__zix__ring__setup.xml', + 'group__zix__ring__types.xml', 'group__zix__ring__write.xml', 'group__zix__sem.xml', 'group__zix__status.xml', @@ -70,6 +75,7 @@ doxygen_xml = custom_target( 'group__zix__tree__modification.xml', 'group__zix__tree__searching.xml', 'group__zix__tree__setup.xml', + 'group__zix__tree__types.xml', 'group__zix__utilities.xml', 'hash_8h.xml', 'path_8h.xml', |