Generate expectations for moved Natspec syntax tests

ethereum · Aug 22, 2023 · a6e703b · a6e703b
1 parent cdf97a2
commit a6e703b
Show file tree

Hide file tree

Showing 10 changed files with 248 additions and 0 deletions.
diff --git a/test/libsolidity/natspecJSON/docstring_double_empty.sol b/test/libsolidity/natspecJSON/docstring_double_empty.sol
@@ -5,3 +5,17 @@ contract C {
   }
 }
 // ----
+// ----
+// :C devdoc
+// {
+//     "kind": "dev",
+//     "methods": {},
+//     "version": 1
+// }
+//
+// :C userdoc
+// {
+//     "kind": "user",
+//     "methods": {},
+//     "version": 1
+// }
diff --git a/test/libsolidity/natspecJSON/docstring_enum.sol b/test/libsolidity/natspecJSON/docstring_enum.sol
@@ -9,3 +9,17 @@ contract C {
     }
 }
 // ----
+// ----
+// :C devdoc
+// {
+//     "kind": "dev",
+//     "methods": {},
+//     "version": 1
+// }
+//
+// :C userdoc
+// {
+//     "kind": "user",
+//     "methods": {},
+//     "version": 1
+// }
diff --git a/test/libsolidity/natspecJSON/docstring_named_return_parameter.sol b/test/libsolidity/natspecJSON/docstring_named_return_parameter.sol
@@ -3,3 +3,26 @@ abstract contract C {
     function vote() public virtual returns (uint value);
 }
 // ----
+// ----
+// :C devdoc
+// {
+//     "kind": "dev",
+//     "methods":
+//     {
+//         "vote()":
+//         {
+//             "returns":
+//             {
+//                 "value": "The value returned by this function."
+//             }
+//         }
+//     },
+//     "version": 1
+// }
+//
+// :C userdoc
+// {
+//     "kind": "user",
+//     "methods": {},
+//     "version": 1
+// }
diff --git a/test/libsolidity/natspecJSON/docstring_parameter.sol b/test/libsolidity/natspecJSON/docstring_parameter.sol
@@ -10,3 +10,17 @@ contract C {
     }
 }
 // ----
+// ----
+// :C devdoc
+// {
+//     "kind": "dev",
+//     "methods": {},
+//     "version": 1
+// }
+//
+// :C userdoc
+// {
+//     "kind": "user",
+//     "methods": {},
+//     "version": 1
+// }
diff --git a/test/libsolidity/natspecJSON/docstring_private_state_variable.sol b/test/libsolidity/natspecJSON/docstring_private_state_variable.sol
@@ -4,3 +4,24 @@ contract C {
     uint private state;
 }
 // ----
+// ----
+// :C devdoc
+// {
+//     "kind": "dev",
+//     "methods": {},
+//     "stateVariables":
+//     {
+//         "state":
+//         {
+//             "details": "example of dev"
+//         }
+//     },
+//     "version": 1
+// }
+//
+// :C userdoc
+// {
+//     "kind": "user",
+//     "methods": {},
+//     "version": 1
+// }
diff --git a/test/libsolidity/natspecJSON/docstring_state_variable.sol b/test/libsolidity/natspecJSON/docstring_state_variable.sol
@@ -4,3 +4,30 @@ contract C {
     uint public state;
 }
 // ----
+// ----
+// :C devdoc
+// {
+//     "kind": "dev",
+//     "methods": {},
+//     "stateVariables":
+//     {
+//         "state":
+//         {
+//             "details": "example of dev"
+//         }
+//     },
+//     "version": 1
+// }
+//
+// :C userdoc
+// {
+//     "kind": "user",
+//     "methods":
+//     {
+//         "state()":
+//         {
+//             "notice": "example of notice"
+//         }
+//     },
+//     "version": 1
+// }
diff --git a/test/libsolidity/natspecJSON/docstring_struct.sol b/test/libsolidity/natspecJSON/docstring_struct.sol
@@ -10,3 +10,17 @@ contract C {
     }
 }
 // ----
+// ----
+// :C devdoc
+// {
+//     "kind": "dev",
+//     "methods": {},
+//     "version": 1
+// }
+//
+// :C userdoc
+// {
+//     "kind": "user",
+//     "methods": {},
+//     "version": 1
+// }
diff --git a/test/libsolidity/natspecJSON/docstring_variable.sol b/test/libsolidity/natspecJSON/docstring_variable.sol
@@ -11,3 +11,17 @@ contract C {
     }
 }
 // ----
+// ----
+// :C devdoc
+// {
+//     "kind": "dev",
+//     "methods": {},
+//     "version": 1
+// }
+//
+// :C userdoc
+// {
+//     "kind": "user",
+//     "methods": {},
+//     "version": 1
+// }
diff --git a/test/libsolidity/natspecJSON/return_param_amount_differs.sol b/test/libsolidity/natspecJSON/return_param_amount_differs.sol
@@ -12,3 +12,53 @@ contract Thing is IThing {
 
     Value public override value;
 }
+// ----
+// ----
+// :IThing devdoc
+// {
+//     "kind": "dev",
+//     "methods":
+//     {
+//         "value()":
+//         {
+//             "returns":
+//             {
+//                 "x": "a number",
+//                 "y": "another number"
+//             }
+//         }
+//     },
+//     "version": 1
+// }
+//
+// :IThing userdoc
+// {
+//     "kind": "user",
+//     "methods": {},
+//     "version": 1
+// }
+//
+// :Thing devdoc
+// {
+//     "kind": "dev",
+//     "methods": {},
+//     "stateVariables":
+//     {
+//         "value":
+//         {
+//             "returns":
+//             {
+//                 "x": "a number",
+//                 "y": "another number"
+//             }
+//         }
+//     },
+//     "version": 1
+// }
+//
+// :Thing userdoc
+// {
+//     "kind": "user",
+//     "methods": {},
+//     "version": 1
+// }
diff --git a/test/libsolidity/natspecJSON/return_param_amount_differs2.sol b/test/libsolidity/natspecJSON/return_param_amount_differs2.sol
@@ -14,3 +14,60 @@ contract Thing is IThing {
     mapping(uint256=>Value) public override value;
 }
 // ----
+// ----
+// :IThing devdoc
+// {
+//     "kind": "dev",
+//     "methods":
+//     {
+//         "value(uint256)":
+//         {
+//             "params":
+//             {
+//                 "v": "value to search for"
+//             },
+//             "returns":
+//             {
+//                 "x": "a number",
+//                 "y": "another number"
+//             }
+//         }
+//     },
+//     "version": 1
+// }
+//
+// :IThing userdoc
+// {
+//     "kind": "user",
+//     "methods": {},
+//     "version": 1
+// }
+//
+// :Thing devdoc
+// {
+//     "kind": "dev",
+//     "methods": {},
+//     "stateVariables":
+//     {
+//         "value":
+//         {
+//             "params":
+//             {
+//                 "v": "value to search for"
+//             },
+//             "returns":
+//             {
+//                 "x": "a number",
+//                 "y": "another number"
+//             }
+//         }
+//     },
+//     "version": 1
+// }
+//
+// :Thing userdoc
+// {
+//     "kind": "user",
+//     "methods": {},
+//     "version": 1
+// }