Fill in docs on some of the new syntax tree nodes

dtolnay · Feb 6, 2023 · 391c9c6 · 391c9c6
1 parent 80b9d4c
commit 391c9c6
Show file tree

Hide file tree

Showing 3 changed files with 16 additions and 11 deletions.
diff --git a/src/item.rs b/src/item.rs
@@ -847,6 +847,17 @@ impl Receiver {
 }
 
 ast_struct! {
+    /// The variadic argument of a foreign function.
+    ///
+    /// ```rust
+    /// # struct c_char;
+    /// # struct c_int;
+    /// #
+    /// extern "C" {
+    ///     fn printf(format: *const c_char, ...) -> c_int;
+    ///     //                               ^^^
+    /// }
+    /// ```
     #[cfg_attr(doc_cfg, doc(cfg(feature = "full")))]
     pub struct Variadic {
         pub attrs: Vec<Attribute>,
@@ -857,6 +868,7 @@ ast_struct! {
 }
 
 ast_enum! {
+    /// The mutability of an `Item::Static` or `ForeignItem::Static`.
     #[cfg_attr(doc_cfg, doc(cfg(feature = "full")))]
     #[non_exhaustive]
     pub enum StaticMutability {
@@ -866,6 +878,7 @@ ast_enum! {
 }
 
 ast_enum! {
+    /// Unused, but reserved for RFC 3323 restrictions.
     #[cfg_attr(doc_cfg, doc(cfg(feature = "full")))]
     #[non_exhaustive]
     pub enum ImplRestriction {}

diff --git a/src/restriction.rs b/src/restriction.rs
@@ -36,6 +36,8 @@ ast_struct! {
 }
 
 ast_enum! {
+    /// Unused, but reserved for RFC 3323 restrictions.
+    #[cfg_attr(doc_cfg, doc(cfg(any(feature = "full", feature = "derive"))))]
     #[non_exhaustive]
     pub enum FieldMutability {
         None,

diff --git a/src/ty.rs b/src/ty.rs
@@ -238,17 +238,7 @@ ast_struct! {
 }
 
 ast_struct! {
-    /// The variadic argument of a foreign function.
-    ///
-    /// ```rust
-    /// # struct c_char;
-    /// # struct c_int;
-    /// #
-    /// extern "C" {
-    ///     fn printf(format: *const c_char, ...) -> c_int;
-    ///     //                               ^^^
-    /// }
-    /// ```
+    /// The variadic argument of a function pointer like `fn(usize, ...)`.
     #[cfg_attr(doc_cfg, doc(cfg(any(feature = "full", feature = "derive"))))]
     pub struct BareVariadic {
         pub attrs: Vec<Attribute>,