cerc-io/solidity
11
0
Fork 0
mirror of https://github.com/ethereum/solidity synced 2023-10-03 13:03:40 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Adds JSON import / export for structured documentation.

Browse Source
This commit is contained in:
Erik Kundt
2020-01-30 18:26:01 +01:00
parent ec27c2e507
commit 4a179056ed
6 changed files with 179 additions and 98 deletions
Download Patch File Download Diff File Expand all files Collapse all files
test/libsolidity/ASTJSON/documentation.json
+61 -31
View File
@@ -4,10 +4,10 @@
{
"C":
[
1
2
]
},
"id": 2,
"id": 3,
"nodeType": "SourceUnit",
"nodes":
[
@@ -16,17 +16,23 @@
"baseContracts": [],
"contractDependencies": [],
"contractKind": "contract",
"documentation": "This contract is empty",
"documentation":
{
"id": 1,
"nodeType": "StructuredDocumentation",
"src": "0:27:1",
"text": "This contract is empty"
},
"fullyImplemented": true,
"id": 1,
"id": 2,
"linearizedBaseContracts":
[
1
2
],
"name": "C",
"nodeType": "ContractDefinition",
"nodes": [],
"scope": 2,
"scope": 3,
"src": "28:13:1"
}
],
@@ -38,10 +44,10 @@
{
"C":
[
3
5
]
},
"id": 4,
"id": 6,
"nodeType": "SourceUnit",
"nodes":
[
@@ -50,17 +56,23 @@
"baseContracts": [],
"contractDependencies": [],
"contractKind": "contract",
"documentation": "This contract is empty\nand has a line-breaking comment.",
"documentation":
{
"id": 4,
"nodeType": "StructuredDocumentation",
"src": "0:61:2",
"text": "This contract is empty\nand has a line-breaking comment."
},
"fullyImplemented": true,
"id": 3,
"id": 5,
"linearizedBaseContracts":
[
3
5
],
"name": "C",
"nodeType": "ContractDefinition",
"nodes": [],
"scope": 4,
"scope": 6,
"src": "62:13:2"
}
],
@@ -72,10 +84,10 @@
{
"C":
[
15
20
]
},
"id": 16,
"id": 21,
"nodeType": "SourceUnit",
"nodes":
[
@@ -86,10 +98,10 @@
"contractKind": "contract",
"documentation": null,
"fullyImplemented": true,
"id": 15,
"id": 20,
"linearizedBaseContracts":
[
15
20
],
"name": "C",
"nodeType": "ContractDefinition",
@@ -97,13 +109,19 @@
[
{
"anonymous": false,
"documentation": "Some comment on Evt.",
"id": 6,
"documentation":
{
"id": 7,
"nodeType": "StructuredDocumentation",
"src": "15:26:3",
"text": "Some comment on Evt."
},
"id": 9,
"name": "Evt",
"nodeType": "EventDefinition",
"parameters":
{
"id": 5,
"id": 8,
"nodeType": "ParameterList",
"parameters": [],
"src": "51:2:3"
@@ -113,26 +131,32 @@
{
"body":
{
"id": 9,
"id": 13,
"nodeType": "Block",
"src": "99:6:3",
"statements":
[
{
"id": 8,
"id": 12,
"nodeType": "PlaceholderStatement",
"src": "101:1:3"
}
]
},
"documentation": "Some comment on mod.",
"id": 10,
"documentation":
{
"id": 10,
"nodeType": "StructuredDocumentation",
"src": "57:26:3",
"text": "Some comment on mod."
},
"id": 14,
"name": "mod",
"nodeType": "ModifierDefinition",
"overrides": null,
"parameters":
{
"id": 7,
"id": 11,
"nodeType": "ParameterList",
"parameters": [],
"src": "96:2:3"
@@ -144,14 +168,20 @@
{
"body":
{
"id": 13,
"id": 18,
"nodeType": "Block",
"src": "155:2:3",
"statements": []
},
"documentation": "Some comment on fn.",
"documentation":
{
"id": 15,
"nodeType": "StructuredDocumentation",
"src": "108:25:3",
"text": "Some comment on fn."
},
"functionSelector": "a4a2c40b",
"id": 14,
"id": 19,
"implemented": true,
"kind": "function",
"modifiers": [],
@@ -160,26 +190,26 @@
"overrides": null,
"parameters":
{
"id": 11,
"id": 16,
"nodeType": "ParameterList",
"parameters": [],
"src": "145:2:3"
},
"returnParameters":
{
"id": 12,
"id": 17,
"nodeType": "ParameterList",
"parameters": [],
"src": "155:0:3"
},
"scope": 15,
"scope": 20,
"src": "134:23:3",
"stateMutability": "nonpayable",
"virtual": false,
"visibility": "public"
}
],
"scope": 16,
"scope": 21,
"src": "0:159:3"
}
],
test/libsolidity/ASTJSON/documentation_legacy.json
+83 -59
View File
@@ -6,7 +6,7 @@
{
"C":
[
15
20
]
}
},
@@ -29,10 +29,10 @@
"fullyImplemented": true,
"linearizedBaseContracts":
[
15
20
],
"name": "C",
"scope": 16
"scope": 21
},
"children":
[
@@ -40,11 +40,19 @@
"attributes":
{
"anonymous": false,
"documentation": "Some comment on Evt.",
"name": "Evt"
},
"children":
[
{
"attributes":
{
"text": "Some comment on Evt."
},
"id": 7,
"name": "StructuredDocumentation",
"src": "15:26:3"
},
{
"attributes":
{
@@ -54,19 +62,18 @@
]
},
"children": [],
"id": 5,
"id": 8,
"name": "ParameterList",
"src": "51:2:3"
}
],
"id": 6,
"id": 9,
"name": "EventDefinition",
"src": "42:12:3"
},
{
"attributes":
{
"documentation": "Some comment on mod.",
"name": "mod",
"overrides": null,
"virtual": false,
@@ -77,55 +84,12 @@
{
"attributes":
{
"parameters":
[
null
]
"text": "Some comment on mod."
},
"children": [],
"id": 7,
"name": "ParameterList",
"src": "96:2:3"
"id": 10,
"name": "StructuredDocumentation",
"src": "57:26:3"
},
{
"children":
[
{
"id": 8,
"name": "PlaceholderStatement",
"src": "101:1:3"
}
],
"id": 9,
"name": "Block",
"src": "99:6:3"
}
],
"id": 10,
"name": "ModifierDefinition",
"src": "84:21:3"
},
{
"attributes":
{
"documentation": "Some comment on fn.",
"functionSelector": "a4a2c40b",
"implemented": true,
"isConstructor": false,
"kind": "function",
"modifiers":
[
null
],
"name": "fn",
"overrides": null,
"scope": 15,
"stateMutability": "nonpayable",
"virtual": false,
"visibility": "public"
},
"children":
[
{
"attributes":
{
@@ -137,6 +101,66 @@
"children": [],
"id": 11,
"name": "ParameterList",
"src": "96:2:3"
},
{
"children":
[
{
"id": 12,
"name": "PlaceholderStatement",
"src": "101:1:3"
}
],
"id": 13,
"name": "Block",
"src": "99:6:3"
}
],
"id": 14,
"name": "ModifierDefinition",
"src": "84:21:3"
},
{
"attributes":
{
"functionSelector": "a4a2c40b",
"implemented": true,
"isConstructor": false,
"kind": "function",
"modifiers":
[
null
],
"name": "fn",
"overrides": null,
"scope": 20,
"stateMutability": "nonpayable",
"virtual": false,
"visibility": "public"
},
"children":
[
{
"attributes":
{
"text": "Some comment on fn."
},
"id": 15,
"name": "StructuredDocumentation",
"src": "108:25:3"
},
{
"attributes":
{
"parameters":
[
null
]
},
"children": [],
"id": 16,
"name": "ParameterList",
"src": "145:2:3"
},
{
@@ -148,7 +172,7 @@
]
},
"children": [],
"id": 12,
"id": 17,
"name": "ParameterList",
"src": "155:0:3"
},
@@ -161,22 +185,22 @@
]
},
"children": [],
"id": 13,
"id": 18,
"name": "Block",
"src": "155:2:3"
}
],
"id": 14,
"id": 19,
"name": "FunctionDefinition",
"src": "134:23:3"
}
],
"id": 15,
"id": 20,
"name": "ContractDefinition",
"src": "0:159:3"
}
],
"id": 16,
"id": 21,
"name": "SourceUnit",
"src": "0:160:3"
}