rustls-ffi icon indicating copy to clipboard operation
rustls-ffi copied to clipboard

docgen/website: show deprecated function warnings on docs website

Open cpu opened this issue 7 months ago • 3 comments

Updates the docgen tool from the tools crate to parse the DEPRECATED_FUNC macro invocations ahead of function declarations. Once parsed we can pull out the argument message and include that in the JSON data generated by the tool.

With the deprecated messages the website Zola templates can reference them to add a note of the deprecation in the TOC and to add a warning banner to the item's docs rendering.

Resolves https://github.com/rustls/rustls-ffi/issues/582

Examples:

toc deprecated banner

cpu avatar Jul 10 '25 20:07 cpu