mirror of
https://github.com/ethereum/solidity
synced 2023-10-03 13:03:40 +00:00
83 lines
2.2 KiB
C++
83 lines
2.2 KiB
C++
/*
|
|
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 Christian <c@ethdev.com>
|
|
* @date 2015
|
|
* Parses and analyses the doc strings.
|
|
* Stores the parsing results in the AST annotations and reports errors.
|
|
*/
|
|
|
|
#pragma once
|
|
|
|
#include <libsolidity/ast/ASTVisitor.h>
|
|
|
|
namespace dev
|
|
{
|
|
namespace solidity
|
|
{
|
|
|
|
class ErrorReporter;
|
|
|
|
/**
|
|
* Parses and analyses the doc strings.
|
|
* Stores the parsing results in the AST annotations and reports errors.
|
|
*/
|
|
class DocStringAnalyser: private ASTConstVisitor
|
|
{
|
|
public:
|
|
DocStringAnalyser(ErrorReporter& _errorReporter): m_errorReporter(_errorReporter) {}
|
|
bool analyseDocStrings(SourceUnit const& _sourceUnit);
|
|
|
|
private:
|
|
virtual bool visit(ContractDefinition const& _contract) override;
|
|
virtual bool visit(FunctionDefinition const& _function) override;
|
|
virtual bool visit(ModifierDefinition const& _modifier) override;
|
|
virtual bool visit(EventDefinition const& _event) override;
|
|
|
|
void checkParameters(
|
|
CallableDeclaration const& _callable,
|
|
DocumentedAnnotation& _annotation
|
|
);
|
|
|
|
void handleConstructor(
|
|
CallableDeclaration const& _callable,
|
|
Documented const& _node,
|
|
DocumentedAnnotation& _annotation
|
|
);
|
|
|
|
void handleCallable(
|
|
CallableDeclaration const& _callable,
|
|
Documented const& _node,
|
|
DocumentedAnnotation& _annotation
|
|
);
|
|
|
|
void parseDocStrings(
|
|
Documented const& _node,
|
|
DocumentedAnnotation& _annotation,
|
|
std::set<std::string> const& _validTags,
|
|
std::string const& _nodeName
|
|
);
|
|
|
|
void appendError(std::string const& _description);
|
|
|
|
bool m_errorOccured = false;
|
|
ErrorReporter& m_errorReporter;
|
|
};
|
|
|
|
}
|
|
}
|