aboutsummaryrefslogtreecommitdiffstats
path: root/CompilerStack.h
diff options
context:
space:
mode:
authorGav Wood <i@gavwood.com>2015-01-09 14:39:30 +0800
committerGav Wood <i@gavwood.com>2015-01-09 14:39:30 +0800
commit29591d6ecfaf1a00ac405b1a46fe366daa00bd71 (patch)
tree2c68fc0c94b1abe666a91bccefd5048d9a9852b0 /CompilerStack.h
parentffce12b7ee412cbd29dd0873a3e894dd7133ca4e (diff)
downloaddexon-solidity-29591d6ecfaf1a00ac405b1a46fe366daa00bd71.tar.gz
dexon-solidity-29591d6ecfaf1a00ac405b1a46fe366daa00bd71.tar.zst
dexon-solidity-29591d6ecfaf1a00ac405b1a46fe366daa00bd71.zip
Documentation update.
Diffstat (limited to 'CompilerStack.h')
-rw-r--r--CompilerStack.h5
1 files changed, 3 insertions, 2 deletions
diff --git a/CompilerStack.h b/CompilerStack.h
index d6378ea1..91836585 100644
--- a/CompilerStack.h
+++ b/CompilerStack.h
@@ -16,6 +16,7 @@
*/
/**
* @author Christian <c@ethdev.com>
+ * @author Gav Wood <g@ethdev.com>
* @date 2014
* Full-stack compiler that converts a source code string to bytecode.
*/
@@ -82,13 +83,13 @@ public:
/// Returns a string representing the contract interface in JSON.
/// Prerequisite: Successful call to parse or compile.
std::string const& getInterface(std::string const& _contractName = "") const;
- /// Returns a string representing the contract interface in JSON.
+ /// Returns a string representing the contract interface in Solidity.
/// Prerequisite: Successful call to parse or compile.
std::string const& getSolidityInterface(std::string const& _contractName = "") const;
/// Returns a string representing the contract's documentation in JSON.
/// Prerequisite: Successful call to parse or compile.
/// @param type The type of the documentation to get.
- /// Can be one of 3 types defined at @c DocumentationType
+ /// Can be one of 4 types defined at @c DocumentationType
std::string const& getJsonDocumentation(std::string const& _contractName, DocumentationType _type) const;
/// @returns the previously used scanner, useful for counting lines during error reporting.