cerc-io/solidity
15
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 #8910 from ethereum/natspec-return-bug

Browse Source 
Bug that ignored return tag when no other devdoc tags were present
This commit is contained in:
chriseth 2020-05-12 16:47:07 +02:00 committed by GitHub
commit 901b421bb8
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 28 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Changelog.md
View File

@ -17,7 +17,7 @@ Bugfixes:
* ABI: Skip ``private`` or ``internal`` constructors. * ABI: Skip ``private`` or ``internal`` constructors.
* Type Checker: Disallow accessing ``runtimeCode`` for contract types that contain immutable state variables. * Type Checker: Disallow accessing ``runtimeCode`` for contract types that contain immutable state variables.
* Fixed an "Assembly Exception in Bytecode" error where requested functions were generated twice. * Fixed an "Assembly Exception in Bytecode" error where requested functions were generated twice.
* Natspec: Fixed a bug that ignored ``@return`` tag when no other developer-documentation tags were present.
### 0.6.7 (2020-05-04) ### 0.6.7 (2020-05-04)

14
libsolidity/interface/Natspec.cpp
View File

@ -99,16 +99,14 @@ Json::Value Natspec::devDocumentation(ContractDefinition const& _contractDef)
if (auto fun = dynamic_cast<FunctionDefinition const*>(&it.second->declaration())) if (auto fun = dynamic_cast<FunctionDefinition const*>(&it.second->declaration()))
{ {
Json::Value method(devDocumentation(fun->annotation().docTags)); Json::Value method(devDocumentation(fun->annotation().docTags));
// add the function, only if we have any documentation to add
Json::Value jsonReturn = extractReturnParameterDocs(fun->annotation().docTags, *fun);
if (!jsonReturn.empty())
method["returns"] = jsonReturn;
if (!method.empty()) if (!method.empty())
{
// add the function, only if we have any documentation to add
Json::Value jsonReturn = extractReturnParameterDocs(fun->annotation().docTags, *fun);
if (!jsonReturn.empty())
method["returns"] = jsonReturn;
methods[it.second->externalSignature()] = method; methods[it.second->externalSignature()] = method;
}
} }
} }

21
test/libsolidity/SolidityNatspecJSON.cpp
View File

@ -355,6 +355,27 @@ BOOST_AUTO_TEST_CASE(dev_multiple_functions)
checkNatspec(sourceCode, "test", natspec, false); checkNatspec(sourceCode, "test", natspec, false);
} }
BOOST_AUTO_TEST_CASE(dev_return_no_params)
{
char const* sourceCode = R"(
contract test {
/// @return d The result of the multiplication
function mul(uint a, uint second) public returns (uint d) { return a * 7 + second; }
}
)";
char const* natspec = R"ABCDEF(
{
"methods": {
"mul(uint256,uint256)": {
"returns": { "d": "The result of the multiplication"
}
}
})ABCDEF";
checkNatspec(sourceCode, "test", natspec, false);
}
BOOST_AUTO_TEST_CASE(dev_return) BOOST_AUTO_TEST_CASE(dev_return)
{ {
char const* sourceCode = R"( char const* sourceCode = R"(