aboutsummaryrefslogtreecommitdiffstats
path: root/InterfaceHandler.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 /InterfaceHandler.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 'InterfaceHandler.h')
-rw-r--r--InterfaceHandler.h12
1 files changed, 9 insertions, 3 deletions
diff --git a/InterfaceHandler.h b/InterfaceHandler.h
index ca9807d7..1cc20c44 100644
--- a/InterfaceHandler.h
+++ b/InterfaceHandler.h
@@ -77,16 +77,22 @@ public:
/// representation of the contract's ABI Interface
std::unique_ptr<std::string> getABIInterface(ContractDefinition const& _contractDef);
std::unique_ptr<std::string> getABISolidityInterface(ContractDefinition const& _contractDef);
+ /// Generate the User documentation of the contract
+ /// @param _contractDef The contract definition
+ void generateUserDocumentation(ContractDefinition& _contractDef);
/// Get the User documentation of the contract
/// @param _contractDef The contract definition
/// @return A unique pointer contained string with the json
/// representation of the contract's user documentation
- std::unique_ptr<std::string> getUserDocumentation(ContractDefinition const& _contractDef);
- /// Get the Developer's documentation of the contract
+ std::unique_ptr<std::string> userDocumentation(ContractDefinition const& _contractDef);
+ /// Genereates the Developer's documentation of the contract
+ /// @param _contractDef The contract definition
+ void generateDevDocumentation(ContractDefinition& _contractDef);
+ /// Genereates the Developer's documentation of the contract
/// @param _contractDef The contract definition
/// @return A unique pointer contained string with the json
/// representation of the contract's developer documentation
- std::unique_ptr<std::string> getDevDocumentation(ContractDefinition const& _contractDef);
+ std::unique_ptr<std::string> devDocumentation(ContractDefinition const& _contractDef);
private:
void resetUser();