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

Implement @erak review notes by creating function and adding constructor test

Browse Source 
Update 060 doc with natspec change

Add two more tests with mixed usage

Fix solc-js

fix changelog
This commit is contained in:
cd10012
2019-11-06 21:44:59 +01:00
committed by chriseth
parent f598b1515f
commit 16fe59b7b4
6 changed files with 146 additions and 48 deletions
Download Patch File Download Diff File Expand all files Collapse all files
libsolidity/interface/Natspec.cpp
+33 -31
View File
@@ -102,38 +102,10 @@ Json::Value Natspec::devDocumentation(ContractDefinition const& _contractDef)
if (!method.empty())
{
// add the function, only if we have any documentation to add
Json::Value ret(Json::objectValue);
Json::Value jsonReturn = extractReturnParameterDocs(fun->annotation().docTags, *fun);
auto returnParams = fun->returnParameters();
auto returnDoc = fun->annotation().docTags.equal_range("return");
if (!returnParams.empty())
{
unsigned int n = 0;
for (auto i = returnDoc.first; i != returnDoc.second; i++)
{
string paramName = returnParams.at(n)->name();
string content = i->second.content;
if (paramName.empty())
{
paramName = "_" + std::to_string(n+1);
}
else
{
//check to make sure the first word of the doc str is the same as the return name
auto nameEndPos = content.find_first_of(" \t");
solAssert(content.substr(0, nameEndPos) == paramName, "No return param name given: " + paramName);
content = content.substr(nameEndPos+1);
}
ret[paramName] = Json::Value(content);
n++;
}
}
if (!ret.empty())
method["return"] = ret;
if (!jsonReturn.empty())
method["returns"] = jsonReturn;
methods[it.second->externalSignature()] = method;
}
@@ -145,6 +117,36 @@ Json::Value Natspec::devDocumentation(ContractDefinition const& _contractDef)
return doc;
}
Json::Value Natspec::extractReturnParameterDocs(std::multimap<std::string, DocTag> const& _tags, FunctionDefinition const& _functionDef)
{
Json::Value jsonReturn{Json::objectValue};
auto returnDocs = _tags.equal_range("return");
if (!_functionDef.returnParameters().empty())
{
size_t n = 0;
for (auto i = returnDocs.first; i != returnDocs.second; i++)
{
string paramName = _functionDef.returnParameters().at(n)->name();
string content = i->second.content;
if (paramName.empty())
paramName = "_" + std::to_string(n);
else
{
//check to make sure the first word of the doc str is the same as the return name
auto nameEndPos = content.find_first_of(" \t");
solAssert(content.substr(0, nameEndPos) == paramName, "No return param name given: " + paramName);
content = content.substr(nameEndPos+1);
}
jsonReturn[paramName] = Json::Value(content);
n++;
}
}
return jsonReturn;
}
string Natspec::extractDoc(multimap<string, DocTag> const& _tags, string const& _name)
{