diff options
author | Christian <c@ethdev.com> | 2014-10-28 23:51:26 +0800 |
---|---|---|
committer | Christian <c@ethdev.com> | 2014-10-28 23:51:26 +0800 |
commit | 933fbd7d60006092cd8846cc164188f7ad41460f (patch) | |
tree | ea0e55efa7ef364cb966ae3e8a019a7ccfa53866 /Types.h | |
parent | fae8ca001ef33041b5ba5debc5a71ecc3eb5645b (diff) | |
download | dexon-solidity-933fbd7d60006092cd8846cc164188f7ad41460f.tar.gz dexon-solidity-933fbd7d60006092cd8846cc164188f7ad41460f.tar.zst dexon-solidity-933fbd7d60006092cd8846cc164188f7ad41460f.zip |
Asterisk-syntax for doxygen class documentation.
Diffstat (limited to 'Types.h')
-rw-r--r-- | Types.h | 40 |
1 files changed, 29 insertions, 11 deletions
@@ -36,7 +36,9 @@ namespace solidity // @todo realMxN, string<N>, mapping -/// Abstract base class that forms the root of the type hierarchy. +/** + * Abstract base class that forms the root of the type hierarchy. + */ class Type: private boost::noncopyable { public: @@ -72,7 +74,9 @@ public: virtual bytes literalToBigEndian(Literal const&) const { return NullBytes; } }; -/// Any kind of integer type including hash and address. +/** + * Any kind of integer type including hash and address. + */ class IntegerType: public Type { public: @@ -106,7 +110,9 @@ private: Modifier m_modifier; }; -/// The boolean type. +/** + * The boolean type. + */ class BoolType: public Type { public: @@ -125,7 +131,9 @@ public: virtual bytes literalToBigEndian(Literal const& _literal) const override; }; -/// The type of a contract instance, there is one distinct type for each contract definition. +/** + * The type of a contract instance, there is one distinct type for each contract definition. + */ class ContractType: public Type { public: @@ -140,7 +148,9 @@ private: ContractDefinition const& m_contract; }; -/// The type of a struct instance, there is one distinct type per struct definition. +/** + * The type of a struct instance, there is one distinct type per struct definition. + */ class StructType: public Type { public: @@ -159,7 +169,9 @@ private: StructDefinition const& m_struct; }; -/// The type of a function, there is one distinct type per function definition. +/** + * The type of a function, there is one distinct type per function definition. + */ class FunctionType: public Type { public: @@ -176,7 +188,9 @@ private: FunctionDefinition const& m_function; }; -/// The type of a mapping, there is one distinct type per key/value type pair. +/** + * The type of a mapping, there is one distinct type per key/value type pair. + */ class MappingType: public Type { public: @@ -191,8 +205,10 @@ private: std::shared_ptr<Type const> m_valueType; }; -/// The void type, can only be implicitly used as the type that is returned by functions without -/// return parameters. +/** + * The void type, can only be implicitly used as the type that is returned by functions without + * return parameters. + */ class VoidType: public Type { public: @@ -202,8 +218,10 @@ public: virtual std::string toString() const override { return "void"; } }; -/// The type of a type reference. The type of "uint32" when used in "a = uint32(2)" is an example -/// of a TypeType. +/** + * The type of a type reference. The type of "uint32" when used in "a = uint32(2)" is an example + * of a TypeType. + */ class TypeType: public Type { public: |