about summary refs log tree commit diff
path: root/src/rustdoc-json-types
diff options
context:
space:
mode:
authorNixon Enraght-Moony <nixon.emoony@gmail.com>2022-10-14 19:57:01 +0100
committerNixon Enraght-Moony <nixon.emoony@gmail.com>2022-10-14 19:57:01 +0100
commitbb04e7e2a2bd0f1a8e0034f6f93bb00673b4c210 (patch)
tree3627526581a91e0c0031fd8e852fda34cdd0b8af /src/rustdoc-json-types
parentee1c3b385b6673b6ef37d80dfabe048e993c2ae2 (diff)
downloadrust-bb04e7e2a2bd0f1a8e0034f6f93bb00673b4c210.tar.gz
rust-bb04e7e2a2bd0f1a8e0034f6f93bb00673b4c210.zip
rustdoc-json: Document and Test that args can be patterns.
Diffstat (limited to 'src/rustdoc-json-types')
-rw-r--r--src/rustdoc-json-types/lib.rs4
1 files changed, 4 insertions, 0 deletions
diff --git a/src/rustdoc-json-types/lib.rs b/src/rustdoc-json-types/lib.rs
index 7379b04ad16..dbbdeecd99d 100644
--- a/src/rustdoc-json-types/lib.rs
+++ b/src/rustdoc-json-types/lib.rs
@@ -618,6 +618,10 @@ pub struct FunctionPointer {
 
 #[derive(Clone, Debug, PartialEq, Eq, Hash, Serialize, Deserialize)]
 pub struct FnDecl {
+    /// List of argument names and their type.
+    ///
+    /// Note that not all names will be valid identifiers, as some of
+    /// them may be patterns.
     pub inputs: Vec<(String, Type)>,
     pub output: Option<Type>,
     pub c_variadic: bool,