mirror of
https://github.com/ethereum/solidity
synced 2023-10-03 13:03:40 +00:00
Add documentation for extractReturnParameterDocs
This commit is contained in:
@@ -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);
|
||||
};
|
||||
|
||||
|
||||
Reference in New Issue
Block a user