cerc-io/solidity
16
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

Absence of tag in Natspec is now considered @notice

Browse Source
This commit is contained in:
Lefteris Karapetsas 2015-01-20 13:15:43 +01:00
parent 1fc3c7b498
commit 8b29bdaf10
1 changed files with 23 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

28
SolidityNatspecJSON.cpp
View File

@ -506,17 +506,35 @@ BOOST_AUTO_TEST_CASE(dev_title_at_function_error)
BOOST_CHECK_THROW(checkNatspec(sourceCode, natspec, false), DocstringParsingError); BOOST_CHECK_THROW(checkNatspec(sourceCode, natspec, false), DocstringParsingError);
} }
// test for bug where having no tags in docstring would cause infinite loop BOOST_AUTO_TEST_CASE(natspec_notice_without_tag)
BOOST_AUTO_TEST_CASE(natspec_no_tags)
{ {
char const* sourceCode = "contract test {\n" char const* sourceCode = "contract test {\n"
" /// I do something awesome\n" " /// I do something awesome\n"
" function mul(uint a, uint second) returns(uint d) { return a * 7 + second; }\n" " function mul(uint a) returns(uint d) { return a * 7; }\n"
"}\n"; "}\n";
char const* natspec = "{\"methods\": {}}"; char const* natspec = "{"
"\"methods\":{"
" \"mul(uint256)\":{ \"notice\": \"I do something awesome\"}"
"}}";
checkNatspec(sourceCode, natspec, false); checkNatspec(sourceCode, natspec, true);
}
BOOST_AUTO_TEST_CASE(natspec_multiline_notice_without_tag)
{
char const* sourceCode = "contract test {\n"
" /// I do something awesome\n"
" /// which requires two lines to explain\n"
" function mul(uint a) returns(uint d) { return a * 7; }\n"
"}\n";
char const* natspec = "{"
"\"methods\":{"
" \"mul(uint256)\":{ \"notice\": \"I do something awesome which requires two lines to explain\"}"
"}}";
checkNatspec(sourceCode, natspec, true);
} }
BOOST_AUTO_TEST_SUITE_END() BOOST_AUTO_TEST_SUITE_END()