From 4148e9d1655f42f6597210bf3c31f582e9342c84 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jonas=20Sch=C3=A4fer?= Date: Tue, 28 Jan 2025 18:24:37 +0100 Subject: [PATCH] xso-proc: hide generated FromXml / AsXml types They really clutter the documentation, because they show up in the module's index. Downside is that users can't inspect the documentation of those types anymore, but it's not useful anyway: the parts are private and they just impl some traits. --- xso-proc/src/state.rs | 2 ++ xso/ChangeLog | 5 +++++ 2 files changed, 7 insertions(+) diff --git a/xso-proc/src/state.rs b/xso-proc/src/state.rs index 4d005a1c..b32fc61b 100644 --- a/xso-proc/src/state.rs +++ b/xso-proc/src/state.rs @@ -520,6 +520,7 @@ impl FromEventsStateMachine { } #[doc = #docstr] + #[doc(hidden)] #vis struct #builder_ty_ident(::core::option::Option<#state_ty_ident>); impl ::xso::FromEventsBuilder for #builder_ty_ident { @@ -698,6 +699,7 @@ impl AsItemsStateMachine { } #[doc = #docstr] + #[doc(hidden)] #vis struct #item_iter_ty(::core::option::Option<#state_ty_ident<#item_iter_ty_lifetime>>); impl<#item_iter_ty_lifetime> ::core::iter::Iterator for #item_iter_ty { diff --git a/xso/ChangeLog b/xso/ChangeLog index 44c0d278..206c6414 100644 --- a/xso/ChangeLog +++ b/xso/ChangeLog @@ -34,6 +34,11 @@ Version NEXT: - New `codec` field on `attribute` meta, to support decoding and encoding using any `TextCodec`. - Support for `no_std` usage (the alloc crate is required, though). + * Changes + - Generated AsXml iterator and FromXml builder types are now + doc(hidden), to not clutter hand-written documentation with auto + generated garbage (something certain big tech companies could take + an example of, honestly). Version 0.1.2: 2024-07-26 Jonas Schäfer