diff options
Diffstat (limited to 'InterfaceHandler.h')
| -rw-r--r-- | InterfaceHandler.h | 12 |
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(); |