diff options
| author | chriseth <chris@ethereum.org> | 2018-11-14 02:33:35 +0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2018-11-14 02:33:35 +0800 |
| commit | 1d4f565a64988a3400847d2655ca24f73f234bc6 (patch) | |
| tree | caaa6c26e307513505349b50ca4f2a8a9506752b /libsolidity/interface/Natspec.h | |
| parent | 59dbf8f1085b8b92e8b7eb0ce380cbeb642e97eb (diff) | |
| parent | 91b6b8a88e76016e0324036cb7a7f9300a1e2439 (diff) | |
| download | dexon-solidity-1d4f565a64988a3400847d2655ca24f73f234bc6.tar dexon-solidity-1d4f565a64988a3400847d2655ca24f73f234bc6.tar.gz dexon-solidity-1d4f565a64988a3400847d2655ca24f73f234bc6.tar.bz2 dexon-solidity-1d4f565a64988a3400847d2655ca24f73f234bc6.tar.lz dexon-solidity-1d4f565a64988a3400847d2655ca24f73f234bc6.tar.xz dexon-solidity-1d4f565a64988a3400847d2655ca24f73f234bc6.tar.zst dexon-solidity-1d4f565a64988a3400847d2655ca24f73f234bc6.zip | |
Merge pull request #5416 from ethereum/develop
Merge develop into release for 0.5.0
Diffstat (limited to 'libsolidity/interface/Natspec.h')
| -rw-r--r-- | libsolidity/interface/Natspec.h | 8 |
1 files changed, 7 insertions, 1 deletions
diff --git a/libsolidity/interface/Natspec.h b/libsolidity/interface/Natspec.h index 0701f821..0be4dda2 100644 --- a/libsolidity/interface/Natspec.h +++ b/libsolidity/interface/Natspec.h @@ -45,7 +45,7 @@ public: /// @param _contractDef The contract definition /// @return A JSON representation of the contract's user documentation static Json::Value userDocumentation(ContractDefinition const& _contractDef); - /// Genereates the Developer's documentation of the contract + /// Generates the Developer's documentation of the contract /// @param _contractDef The contract definition /// @return A JSON representation /// of the contract's developer documentation @@ -54,6 +54,12 @@ public: private: /// @returns concatenation of all content under the given tag name. static std::string extractDoc(std::multimap<std::string, DocTag> const& _tags, std::string const& _name); + + /// Helper-function that will create a json object with dev specific annotations, if present. + /// @param _tags docTags that are used. + /// @return A JSON representation + /// of the contract's developer documentation + static Json::Value devDocumentation(std::multimap<std::string, DocTag> const &_tags); }; } //solidity NS |