cerc-io/solidity
10
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 #11167 from ethereum/natspec-custom

Browse Source 
Show proper error for misusing the custom natspec tag
This commit is contained in:
chriseth 2021-03-25 14:32:29 +01:00 committed by GitHub
commit 4cfb1e5cae
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 11 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
libsolidity/analysis/DocStringTagParser.cpp
View File

@ -163,7 +163,13 @@ void DocStringTagParser::parseDocStrings(
for (auto const& [tagName, tagValue]: _annotation.docTags) for (auto const& [tagName, tagValue]: _annotation.docTags)
{ {
string static const customPrefix("custom:"); string static const customPrefix("custom:");
if (boost::starts_with(tagName, customPrefix) && tagName.size() > customPrefix.size()) if (tagName == "custom" || tagName == "custom:")
m_errorReporter.docstringParsingError(
6564_error,
_node.documentation()->location(),
"Custom documentation tag must contain a chosen name, i.e. @custom:mytag."
);
else if (boost::starts_with(tagName, customPrefix) && tagName.size() > customPrefix.size())
{ {
regex static const customRegex("^custom:[a-z][a-z-]*$"); regex static const customRegex("^custom:[a-z][a-z-]*$");
if (!regex_match(tagName, customRegex)) if (!regex_match(tagName, customRegex))

5
test/libsolidity/syntaxTests/natspec/invalid/invalid_tag.sol
View File

@ -8,9 +8,12 @@ contract C {
function h() public pure {} function h() public pure {}
/// @custom:abc-def /// @custom:abc-def
function i() public pure {} function i() public pure {}
/// @custom
function j() public pure {}
} }
// ---- // ----
// DocstringParsingError 6546: (0-14): Documentation tag @a&b not valid for contracts. // DocstringParsingError 6546: (0-14): Documentation tag @a&b not valid for contracts.
// DocstringParsingError 2968: (28-49): Invalid character in custom tag @custom:x^y. Only lowercase letters and "-" are permitted. // DocstringParsingError 2968: (28-49): Invalid character in custom tag @custom:x^y. Only lowercase letters and "-" are permitted.
// DocstringParsingError 6546: (80-92): Documentation tag @custom: not valid for functions. // DocstringParsingError 6564: (80-92): Custom documentation tag must contain a chosen name, i.e. @custom:mytag.
// DocstringParsingError 2968: (123-141): Invalid character in custom tag @custom:abcDEF. Only lowercase letters and "-" are permitted. // DocstringParsingError 2968: (123-141): Invalid character in custom tag @custom:abcDEF. Only lowercase letters and "-" are permitted.
// DocstringParsingError 6564: (222-233): Custom documentation tag must contain a chosen name, i.e. @custom:mytag.