solidity/libsolidity/interface/Natspec.h

72 lines
2.6 KiB
C
Raw Normal View History

/*
This file is part of solidity.
solidity is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
solidity is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU General Public License for more details.
You should have received a copy of the GNU General Public License
along with solidity. If not, see <http://www.gnu.org/licenses/>.
*/
/**
* @author Lefteris <lefteris@ethdev.com>
* @date 2014
2017-05-10 09:54:23 +00:00
* Takes the parsed AST and produces the Natspec documentation:
* https://github.com/ethereum/wiki/wiki/Ethereum-Natural-Specification-Format
*
* Can generally deal with JSON files
*/
#pragma once
2015-02-10 11:15:44 +00:00
#include <json/json.h>
2018-12-17 18:24:42 +00:00
#include <memory>
#include <string>
#include <libsolidity/ast/AST.h>
2019-12-11 16:31:36 +00:00
namespace solidity::frontend
{
// Forward declarations
class ContractDefinition;
2015-10-26 14:13:36 +00:00
struct DocTag;
2017-05-10 09:56:21 +00:00
class Natspec
{
public:
/// Get the User documentation of the contract
/// @param _contractDef The contract definition
/// @return A JSON representation of the contract's user documentation
static Json::Value userDocumentation(ContractDefinition const& _contractDef);
/// Generates the Developer's documentation of the contract
/// @param _contractDef The contract definition
/// @return A JSON representation
2015-07-15 14:23:10 +00:00
/// of the contract's developer documentation
static Json::Value devDocumentation(ContractDefinition const& _contractDef);
private:
/// @returns concatenation of all content under the given tag name.
2015-10-26 14:13:36 +00:00
static std::string extractDoc(std::multimap<std::string, DocTag> const& _tags, std::string const& _name);
/// Helper-function that will create a json object with dev specific annotations, if present.
/// @param _tags docTags that are used.
/// @return A JSON representation
/// of the contract's developer documentation
2019-02-14 10:37:24 +00:00
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);
};
2019-12-11 16:31:36 +00:00
}