diff options
author | Lefteris Karapetsas <lefteris@refu.co> | 2014-12-03 20:50:04 +0800 |
---|---|---|
committer | Lefteris Karapetsas <lefteris@refu.co> | 2014-12-03 20:50:04 +0800 |
commit | be81981ec4a3a9e7704b230096d9a580175d759e (patch) | |
tree | c3f8f0eacef488f7f597e0a275cee5ff10a73d59 /CompilerStack.h | |
parent | 06998aa2d22b4d40fd9d5ad713f249252544ce8e (diff) | |
download | dexon-solidity-be81981ec4a3a9e7704b230096d9a580175d759e.tar.gz dexon-solidity-be81981ec4a3a9e7704b230096d9a580175d759e.tar.zst dexon-solidity-be81981ec4a3a9e7704b230096d9a580175d759e.zip |
Separate user and dev natspec documentation
- plus other small changes according to the spec
Diffstat (limited to 'CompilerStack.h')
-rw-r--r-- | CompilerStack.h | 10 |
1 files changed, 7 insertions, 3 deletions
diff --git a/CompilerStack.h b/CompilerStack.h index 74784c5e..4e0d2251 100644 --- a/CompilerStack.h +++ b/CompilerStack.h @@ -62,9 +62,12 @@ public: /// Returns a string representing the contract interface in JSON. /// Prerequisite: Successful call to parse or compile. std::string const& getInterface(); - /// Returns a string representing the contract documentation in JSON. + /// Returns a string representing the contract's user documentation in JSON. /// Prerequisite: Successful call to parse or compile. - std::string const& getDocumentation(); + std::string const& getUserDocumentation(); + /// Returns a string representing the contract's developer documentation in JSON. + /// Prerequisite: Successful call to parse or compile. + std::string const& getDevDocumentation(); /// Returns the previously used scanner, useful for counting lines during error reporting. Scanner const& getScanner() const { return *m_scanner; } @@ -80,7 +83,8 @@ private: std::shared_ptr<ContractDefinition> m_contractASTNode; bool m_parseSuccessful; std::string m_interface; - std::string m_documentation; + std::string m_userDocumentation; + std::string m_devDocumentation; std::shared_ptr<Compiler> m_compiler; bytes m_bytecode; }; |