aboutsummaryrefslogtreecommitdiffstats
path: root/AST.h
diff options
context:
space:
mode:
authorLiana Husikyan <liana@ethdev.com>2015-06-15 21:21:23 +0800
committerLiana Husikyan <liana@ethdev.com>2015-07-16 19:57:55 +0800
commit43398adc99b1e05c80dd31d44d742b4851c8771d (patch)
tree00e7e4434bb7b9b66a63b17b4834a780b55141ce /AST.h
parent54fa8ed7a69cdb9e4e83b3039d4e8a8806f11976 (diff)
downloaddexon-solidity-43398adc99b1e05c80dd31d44d742b4851c8771d.tar
dexon-solidity-43398adc99b1e05c80dd31d44d742b4851c8771d.tar.gz
dexon-solidity-43398adc99b1e05c80dd31d44d742b4851c8771d.tar.bz2
dexon-solidity-43398adc99b1e05c80dd31d44d742b4851c8771d.tar.lz
dexon-solidity-43398adc99b1e05c80dd31d44d742b4851c8771d.tar.xz
dexon-solidity-43398adc99b1e05c80dd31d44d742b4851c8771d.tar.zst
dexon-solidity-43398adc99b1e05c80dd31d44d742b4851c8771d.zip
contract documentation is now parsing during compilation and not by request.
Diffstat (limited to 'AST.h')
-rw-r--r--AST.h10
1 files changed, 10 insertions, 0 deletions
diff --git a/AST.h b/AST.h
index 658b3de9..38262d00 100644
--- a/AST.h
+++ b/AST.h
@@ -281,6 +281,12 @@ public:
/// Returns the fallback function or nullptr if no fallback function was specified.
FunctionDefinition const* getFallbackFunction() const;
+ std::unique_ptr<std::string> userDocumentation() const;
+ void setUserDocumentation(std::string const& _userDocumentation);
+
+ std::unique_ptr<std::string> devDocumentation() const;
+ void setDevDocumentation(std::string const& _devDocumentation);
+
private:
/// Checks that two functions defined in this contract with the same name have different
/// arguments and that there is at most one constructor.
@@ -302,6 +308,10 @@ private:
std::vector<ASTPointer<ModifierDefinition>> m_functionModifiers;
std::vector<ASTPointer<EventDefinition>> m_events;
+ // parsed Natspec documentation of the contract.
+ std::string m_userDocumentation;
+ std::string m_devDocumentation;
+
std::vector<ContractDefinition const*> m_linearizedBaseContracts;
mutable std::unique_ptr<std::vector<std::pair<FixedHash<4>, FunctionTypePointer>>> m_interfaceFunctionList;
mutable std::unique_ptr<std::vector<ASTPointer<EventDefinition>>> m_interfaceEvents;