xso-proc: hide generated FromXml / AsXml types

Jonas Schäfer created 1 year ago

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.

Change summary

xso-proc/src/state.rs | 2 ++
xso/ChangeLog         | 5 +++++
2 files changed, 7 insertions(+)

Detailed changes

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 {

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 <[e-mail]>