mirror of
https://github.com/ethereum/solidity
synced 2023-10-03 13:03:40 +00:00
Rename InterfaceHandler to Natspec
This commit is contained in:
parent
12328b7848
commit
81877cc594
@ -38,7 +38,7 @@
|
|||||||
#include <libsolidity/analysis/SyntaxChecker.h>
|
#include <libsolidity/analysis/SyntaxChecker.h>
|
||||||
#include <libsolidity/codegen/Compiler.h>
|
#include <libsolidity/codegen/Compiler.h>
|
||||||
#include <libsolidity/interface/ABI.h>
|
#include <libsolidity/interface/ABI.h>
|
||||||
#include <libsolidity/interface/InterfaceHandler.h>
|
#include <libsolidity/interface/Natspec.h>
|
||||||
#include <libsolidity/interface/GasEstimator.h>
|
#include <libsolidity/interface/GasEstimator.h>
|
||||||
#include <libsolidity/formal/Why3Translator.h>
|
#include <libsolidity/formal/Why3Translator.h>
|
||||||
|
|
||||||
@ -220,8 +220,8 @@ bool CompilerStack::analyze()
|
|||||||
TypeChecker typeChecker(m_errors);
|
TypeChecker typeChecker(m_errors);
|
||||||
if (typeChecker.checkTypeRequirements(*contract))
|
if (typeChecker.checkTypeRequirements(*contract))
|
||||||
{
|
{
|
||||||
contract->setDevDocumentation(InterfaceHandler::devDocumentation(*contract));
|
contract->setDevDocumentation(Natspec::devDocumentation(*contract));
|
||||||
contract->setUserDocumentation(InterfaceHandler::userDocumentation(*contract));
|
contract->setUserDocumentation(Natspec::userDocumentation(*contract));
|
||||||
}
|
}
|
||||||
else
|
else
|
||||||
noErrors = false;
|
noErrors = false;
|
||||||
@ -492,7 +492,7 @@ Json::Value const& CompilerStack::metadata(Contract const& _contract, Documentat
|
|||||||
|
|
||||||
// caches the result
|
// caches the result
|
||||||
if (!*doc)
|
if (!*doc)
|
||||||
doc->reset(new Json::Value(InterfaceHandler::documentation(*_contract.contract, _type)));
|
doc->reset(new Json::Value(Natspec::documentation(*_contract.contract, _type)));
|
||||||
|
|
||||||
return *(*doc);
|
return *(*doc);
|
||||||
}
|
}
|
||||||
|
@ -59,7 +59,7 @@ class FunctionDefinition;
|
|||||||
class SourceUnit;
|
class SourceUnit;
|
||||||
class Compiler;
|
class Compiler;
|
||||||
class GlobalContext;
|
class GlobalContext;
|
||||||
class InterfaceHandler;
|
class Natspec;
|
||||||
class Error;
|
class Error;
|
||||||
class DeclarationContainer;
|
class DeclarationContainer;
|
||||||
|
|
||||||
|
@ -23,7 +23,7 @@
|
|||||||
* Can generally deal with JSON files
|
* Can generally deal with JSON files
|
||||||
*/
|
*/
|
||||||
|
|
||||||
#include <libsolidity/interface/InterfaceHandler.h>
|
#include <libsolidity/interface/Natspec.h>
|
||||||
#include <boost/range/irange.hpp>
|
#include <boost/range/irange.hpp>
|
||||||
#include <libsolidity/ast/AST.h>
|
#include <libsolidity/ast/AST.h>
|
||||||
#include <libsolidity/interface/CompilerStack.h>
|
#include <libsolidity/interface/CompilerStack.h>
|
||||||
@ -32,7 +32,7 @@ using namespace std;
|
|||||||
using namespace dev;
|
using namespace dev;
|
||||||
using namespace dev::solidity;
|
using namespace dev::solidity;
|
||||||
|
|
||||||
Json::Value InterfaceHandler::documentation(
|
Json::Value Natspec::documentation(
|
||||||
ContractDefinition const& _contractDef,
|
ContractDefinition const& _contractDef,
|
||||||
DocumentationType _type
|
DocumentationType _type
|
||||||
)
|
)
|
||||||
@ -48,7 +48,7 @@ Json::Value InterfaceHandler::documentation(
|
|||||||
BOOST_THROW_EXCEPTION(InternalCompilerError() << errinfo_comment("Unknown documentation type"));
|
BOOST_THROW_EXCEPTION(InternalCompilerError() << errinfo_comment("Unknown documentation type"));
|
||||||
}
|
}
|
||||||
|
|
||||||
Json::Value InterfaceHandler::userDocumentation(ContractDefinition const& _contractDef)
|
Json::Value Natspec::userDocumentation(ContractDefinition const& _contractDef)
|
||||||
{
|
{
|
||||||
Json::Value doc;
|
Json::Value doc;
|
||||||
Json::Value methods(Json::objectValue);
|
Json::Value methods(Json::objectValue);
|
||||||
@ -71,7 +71,7 @@ Json::Value InterfaceHandler::userDocumentation(ContractDefinition const& _contr
|
|||||||
return doc;
|
return doc;
|
||||||
}
|
}
|
||||||
|
|
||||||
Json::Value InterfaceHandler::devDocumentation(ContractDefinition const& _contractDef)
|
Json::Value Natspec::devDocumentation(ContractDefinition const& _contractDef)
|
||||||
{
|
{
|
||||||
Json::Value doc;
|
Json::Value doc;
|
||||||
Json::Value methods(Json::objectValue);
|
Json::Value methods(Json::objectValue);
|
||||||
@ -120,7 +120,7 @@ Json::Value InterfaceHandler::devDocumentation(ContractDefinition const& _contra
|
|||||||
return doc;
|
return doc;
|
||||||
}
|
}
|
||||||
|
|
||||||
string InterfaceHandler::extractDoc(multimap<string, DocTag> const& _tags, string const& _name)
|
string Natspec::extractDoc(multimap<string, DocTag> const& _tags, string const& _name)
|
||||||
{
|
{
|
||||||
string value;
|
string value;
|
||||||
auto range = _tags.equal_range(_name);
|
auto range = _tags.equal_range(_name);
|
@ -58,7 +58,7 @@ enum class CommentOwner
|
|||||||
Function
|
Function
|
||||||
};
|
};
|
||||||
|
|
||||||
class InterfaceHandler
|
class Natspec
|
||||||
{
|
{
|
||||||
public:
|
public:
|
||||||
/// Get the given type of documentation
|
/// Get the given type of documentation
|
@ -27,7 +27,6 @@
|
|||||||
#include <libsolidity/parsing/Scanner.h>
|
#include <libsolidity/parsing/Scanner.h>
|
||||||
#include <libsolidity/inlineasm/AsmParser.h>
|
#include <libsolidity/inlineasm/AsmParser.h>
|
||||||
#include <libsolidity/interface/Exceptions.h>
|
#include <libsolidity/interface/Exceptions.h>
|
||||||
#include <libsolidity/interface/InterfaceHandler.h>
|
|
||||||
|
|
||||||
using namespace std;
|
using namespace std;
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user