diff options
| author | Liana Husikyan <liana@ethdev.com> | 2015-06-19 21:40:09 +0800 |
|---|---|---|
| committer | Liana Husikyan <liana@ethdev.com> | 2015-07-16 19:57:56 +0800 |
| commit | dc605218dac6f5d813da36ff3302d248ae7d1465 (patch) | |
| tree | abb3de9280a86f1ad42ae4c7db8fafed3dd75eff /InterfaceHandler.h | |
| parent | 0111d3d4c442230803886fa20654e8d62517814d (diff) | |
| download | dexon-solidity-dc605218dac6f5d813da36ff3302d248ae7d1465.tar dexon-solidity-dc605218dac6f5d813da36ff3302d248ae7d1465.tar.gz dexon-solidity-dc605218dac6f5d813da36ff3302d248ae7d1465.tar.bz2 dexon-solidity-dc605218dac6f5d813da36ff3302d248ae7d1465.tar.lz dexon-solidity-dc605218dac6f5d813da36ff3302d248ae7d1465.tar.xz dexon-solidity-dc605218dac6f5d813da36ff3302d248ae7d1465.tar.zst dexon-solidity-dc605218dac6f5d813da36ff3302d248ae7d1465.zip | |
changed implementation according to notes from code review
Diffstat (limited to 'InterfaceHandler.h')
| -rw-r--r-- | InterfaceHandler.h | 19 |
1 files changed, 6 insertions, 13 deletions
diff --git a/InterfaceHandler.h b/InterfaceHandler.h index 1cc20c44..222db5a0 100644 --- a/InterfaceHandler.h +++ b/InterfaceHandler.h @@ -65,9 +65,8 @@ public: /// @param _contractDef The contract definition /// @param _type The type of the documentation. Can be one of the /// types provided by @c DocumentationType - /// @return A unique pointer contained string with the json - /// representation of provided type - std::unique_ptr<std::string> getDocumentation( + /// @return A string with the json representation of provided type + std::string getDocumentation( ContractDefinition const& _contractDef, DocumentationType _type ); @@ -75,24 +74,18 @@ public: /// @param _contractDef The contract definition /// @return A unique pointer contained string with the json /// 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); + std::string getABIInterface(ContractDefinition const& _contractDef); + std::string getABISolidityInterface(ContractDefinition const& _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> userDocumentation(ContractDefinition const& _contractDef); - /// Genereates the Developer's documentation of the contract - /// @param _contractDef The contract definition - void generateDevDocumentation(ContractDefinition& _contractDef); + std::string userDocumentation(ContractDefinition const& _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> devDocumentation(ContractDefinition const& _contractDef); + std::string devDocumentation(ContractDefinition const& _contractDef); private: void resetUser(); |