Add documentation for extractReturnParameterDocs

This commit is contained in:
cd10012
2019-11-06 21:45:01 +01:00
committed by chriseth
parent 16fe59b7b4
commit a94d22e5fe
3 changed files with 10 additions and 4 deletions
+6
View File
@@ -61,6 +61,12 @@ private:
/// @return A JSON representation
/// of the contract's developer documentation
static Json::Value devDocumentation(std::multimap<std::string, DocTag> const& _tags);
/// Helper-function that will create a json object for the "returns" field for a given function definition.
/// @param _tags docTags that are used.
/// @param _functionDef functionDefinition that is used to determine which return parameters are named.
/// @return A JSON representation
/// of a method's return notice documentation
static Json::Value extractReturnParameterDocs(std::multimap<std::string, DocTag> const& _tags, FunctionDefinition const& _functionDef);
};