Skip to content

Commit

Permalink
Doxygen visualizes deprecated and experimental modules
Browse files Browse the repository at this point in the history
  • Loading branch information
reneme committed Mar 25, 2024
1 parent b37cb27 commit b8c1d3c
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 0 deletions.
2 changes: 2 additions & 0 deletions configure.py
Original file line number Diff line number Diff line change
Expand Up @@ -3493,6 +3493,8 @@ def escape_build_lines(contents):
'title': info.name,
'internal': info.is_internal(),
'virtual': info.is_virtual(),
'deprecated': info.is_deprecated(),
'experimental': info.is_experimental(),
'brief': info.brief,
'public_headers': info.header_public,
'internal_headers': info.header_internal,
Expand Down
16 changes: 16 additions & 0 deletions src/build-data/module_info.in
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,22 @@
* build policy nor `--enable-modules`. Please feel free to enable/disable
* the sub-modules listed.
*
%{endif}
%{if deprecated}
* @deprecated This module is scheduled for removal in a future release of the
* library. Users should move away from it before updating to a new
* version of the library. Note that deprecated modules may be explicitly
* disabled using `--disable-modules=MODS` or generically using
* `--disable-deprecated-features`.
%{endif}
%{if experimental}
* @warning This module is marked as 'experimental'. Its functionality and API
* may change in future (minor) releases. Also, its implementation
* quality must be considered 'beta' at best. Applications may still
* enable and use it explicitly via `--enable-modules=MODS` or
* generically using `--enable-experimental-features`. Early feedback
* is very welcome.
*
%{endif}
*
%{if dependencies}
Expand Down

0 comments on commit b8c1d3c

Please sign in to comment.