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

Merge pull request #8806 from ethereum/natspec-constructor

Browse Source 
[BREAKING] Natspec constructor and functions have consistent userdoc
This commit is contained in:
Harikrishnan Mulackal
2020-05-05 15:47:34 +05:30
committed by GitHub
parent ecbf216354 aa65e9423c
commit dd7d63925a
3 changed files with 17 additions and 9 deletions
Download Patch File Download Diff File Expand all files Collapse all files
test/libsolidity/SolidityNatspecJSON.cpp
+11 -7
View File
@@ -849,16 +849,18 @@ BOOST_AUTO_TEST_CASE(dev_documenting_no_param_description)
BOOST_AUTO_TEST_CASE(user_constructor)
{
char const *sourceCode = R"(
char const* sourceCode = R"(
contract test {
/// @notice this is a really nice constructor
constructor(uint a, uint second) public { }
}
)";
char const *natspec = R"ABCDEF({
"methods" : {
"constructor" : "this is a really nice constructor"
char const* natspec = R"ABCDEF({
"methods": {
"constructor" : {
"notice": "this is a really nice constructor"
}
}
})ABCDEF";
@@ -867,7 +869,7 @@ BOOST_AUTO_TEST_CASE(user_constructor)
BOOST_AUTO_TEST_CASE(user_constructor_and_function)
{
char const *sourceCode = R"(
char const* sourceCode = R"(
contract test {
/// @notice this is a really nice constructor
constructor(uint a, uint second) public { }
@@ -876,12 +878,14 @@ BOOST_AUTO_TEST_CASE(user_constructor_and_function)
}
)";
char const *natspec = R"ABCDEF({
char const* natspec = R"ABCDEF({
"methods" : {
"mul(uint256,uint256)" : {
"notice" : "another multiplier"
},
"constructor" : "this is a really nice constructor"
"constructor" : {
"notice" : "this is a really nice constructor"
}
}
})ABCDEF";