aboutsummaryrefslogtreecommitdiffstats
path: root/InterfaceHandler.h
diff options
context:
space:
mode:
authorLefteris Karapetsas <lefteris@refu.co>2014-12-04 00:46:04 +0800
committerLefteris Karapetsas <lefteris@refu.co>2014-12-04 00:46:04 +0800
commita0ff2179d46404e265226981f8f7cd99c7aba5d1 (patch)
treec8064c27d4369d498bd4bab9d82dc78f611bdad4 /InterfaceHandler.h
parentd25581de7cc89470a060625c043dba8cf9ae293f (diff)
downloaddexon-solidity-a0ff2179d46404e265226981f8f7cd99c7aba5d1.tar.gz
dexon-solidity-a0ff2179d46404e265226981f8f7cd99c7aba5d1.tar.zst
dexon-solidity-a0ff2179d46404e265226981f8f7cd99c7aba5d1.zip
Work in progress for parsing natspec doxytags
Diffstat (limited to 'InterfaceHandler.h')
-rw-r--r--InterfaceHandler.h11
1 files changed, 9 insertions, 2 deletions
diff --git a/InterfaceHandler.h b/InterfaceHandler.h
index ed6c8ba4..125ecda4 100644
--- a/InterfaceHandler.h
+++ b/InterfaceHandler.h
@@ -20,7 +20,7 @@
* Takes the parsed AST and produces the Natspec
* documentation and the ABI interface
* https://github.com/ethereum/wiki/wiki/Ethereum-Natural-Specification-Format
- *
+ *
* Can generally deal with JSON files
*/
@@ -44,7 +44,7 @@ public:
/// Get the given type of documentation
/// @param _contractDef The contract definition
- /// @param _type The type of the documentation. Can be one of the
+ /// @param _type The type of the documentation. Can be one of the
/// types provided by @c documentation_type
/// @return A unique pointer contained string with the json
/// representation of provided type
@@ -67,7 +67,14 @@ public:
std::unique_ptr<std::string> getDevDocumentation(std::shared_ptr<ContractDefinition> _contractDef);
private:
+ void parseDocString(std::string const& _string, size_t _startPos = 0);
+ size_t parseDocTag(std::string const& _string, std::string const& _tag, size_t _pos);
+
Json::StyledWriter m_writer;
+
+ // internal state
+ std::string m_notice;
+ std::string m_dev;
};
} //solidity NS