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

Add documentation for extractReturnParameterDocs

Browse Source
This commit is contained in:
cd10012 2019-10-28 19:09:18 -04:00 committed by chriseth
parent 16fe59b7b4
commit a94d22e5fe
3 changed files with 10 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
libsolidity/interface/Natspec.h
View File

@ -61,6 +61,12 @@ private:
/// @return A JSON representation /// @return A JSON representation
/// of the contract's developer documentation /// of the contract's developer documentation
static Json::Value devDocumentation(std::multimap<std::string, DocTag> const& _tags); 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); static Json::Value extractReturnParameterDocs(std::multimap<std::string, DocTag> const& _tags, FunctionDefinition const& _functionDef);
}; };

6
test/compilationTests/gnosis/MarketMakers/LMSRMarketMaker.sol
View File

@ -131,9 +131,9 @@ contract LMSRMarketMaker is MarketMaker {
/// @param netOutcomeTokensSold Net outcome tokens sold by market /// @param netOutcomeTokensSold Net outcome tokens sold by market
/// @param funding Initial funding for market /// @param funding Initial funding for market
/// @param outcomeIndex Index of exponential term to extract (for use by marginal price function) /// @param outcomeIndex Index of exponential term to extract (for use by marginal price function)
/// @return sum of the outcomes /// @return sum The sum of the outcomes
/// @return offset that is used for all /// @return offset The offset that is used for all
/// @return outcomeExpTerm the summand associated with the supplied index /// @return outcomeExpTerm The summand associated with the supplied index
function sumExpOffset(int logN, int[] memory netOutcomeTokensSold, uint funding, uint8 outcomeIndex) function sumExpOffset(int logN, int[] memory netOutcomeTokensSold, uint funding, uint8 outcomeIndex)
private private
view view