Add documentation for extractReturnParameterDocs

libsolidity/interface/Natspec.h

@@ -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);
 };
 

test/compilationTests/gnosis/MarketMakers/LMSRMarketMaker.sol

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

test/libsolidity/SolidityNatspecJSON.cpp

@@ -468,7 +468,7 @@ BOOST_AUTO_TEST_CASE(dev_return_desc_multiple_unamed_mixed_2)
 			/// @return _milk And milk with nutella
 			function mul(uint a, uint second) public returns (uint _cookies, uint, uint _milk) {
 				uint mul = a * 7;
-        uint milk = 4;
+				uint milk = 4;
 				return (mul, second, milk);
 			}
 		}