solidity/libsolidity/analysis/DocStringAnalyser.h

72 lines
1.9 KiB
C
Raw Normal View History

2015-10-26 14:13:36 +00:00
/*
This file is part of solidity.
2015-10-26 14:13:36 +00:00
solidity is free software: you can redistribute it and/or modify
2015-10-26 14:13:36 +00:00
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,
2015-10-26 14:13:36 +00:00
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/>.
2015-10-26 14:13:36 +00:00
*/
/**
* @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
{
/**
* Parses and analyses the doc strings.
* Stores the parsing results in the AST annotations and reports errors.
*/
class DocStringAnalyser: private ASTConstVisitor
{
public:
DocStringAnalyser(ErrorList& _errors): m_errors(_errors) {}
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;
2015-10-26 16:20:29 +00:00
virtual bool visitNode(ASTNode const&) override;
2015-10-26 14:13:36 +00:00
void handleCallable(
CallableDeclaration const& _callable,
Documented const& _node,
DocumentedAnnotation& _annotation
);
2015-10-26 16:20:29 +00:00
void parseDocStrings(
Documented const& _node,
DocumentedAnnotation& _annotation,
std::set<std::string> const& _validTags,
std::string const& _nodeName
);
2015-10-26 14:13:36 +00:00
void appendError(std::string const& _description);
bool m_errorOccured = false;
ErrorList& m_errors;
};
}
}