Separate user and dev natspec documentation

- plus other small changes according to the spec
This commit is contained in:
Lefteris Karapetsas
2014-12-03 13:50:04 +01:00
parent 06998aa2d2
commit be81981ec4
2 changed files with 25 additions and 8 deletions
+7 -3
View File
@@ -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;
};