aboutsummaryrefslogtreecommitdiffstats
path: root/docs/using-the-compiler.rst
diff options
context:
space:
mode:
authorZhen Zhang <izgzhen@gmail.com>2017-10-20 12:51:13 +0800
committerAlex Beregszaszi <alex@rtfs.hu>2017-12-12 11:02:30 +0800
commitd50e8abefb0631ff5892723d50611c63e76099c7 (patch)
treeb8ea8e7dc8d72b38ed206ac64dbfd915b945384f /docs/using-the-compiler.rst
parent539b8f3b45183ea28219ab31bea73ea033616006 (diff)
downloaddexon-solidity-d50e8abefb0631ff5892723d50611c63e76099c7.tar.gz
dexon-solidity-d50e8abefb0631ff5892723d50611c63e76099c7.tar.zst
dexon-solidity-d50e8abefb0631ff5892723d50611c63e76099c7.zip
Document JSON I/O error classes
Diffstat (limited to 'docs/using-the-compiler.rst')
-rw-r--r--docs/using-the-compiler.rst21
1 files changed, 20 insertions, 1 deletions
diff --git a/docs/using-the-compiler.rst b/docs/using-the-compiler.rst
index c12750c8..f1f13b82 100644
--- a/docs/using-the-compiler.rst
+++ b/docs/using-the-compiler.rst
@@ -177,7 +177,8 @@ Output Description
start: 0,
end: 100
],
- // Mandatory: Error type, such as "TypeError", "InternalCompilerError", "Exception", etc
+ // Mandatory: Error type, such as "TypeError", "InternalCompilerError", "Exception", etc.
+ // See below for complete list of types.
type: "TypeError",
// Mandatory: Component where the error originated, such as "general", "ewasm", etc.
component: "general",
@@ -273,3 +274,21 @@ Output Description
}
}
}
+
+
+Error types
+~~~~~~~~~~~
+
+1. ``JSONError``: JSON input doesn't conform to the required format, e.g. input is not a JSON object, the language is not supported, etc.
+2. ``IOError``: IO and import processing errors, such as unresolvable URL or hash mismatch in supplied sources.
+3. ``ParserError``: Source code doesn't conform to the language rules.
+4. ``DocstringParsingError``: The NatSpec tags in the comment block cannot be parsed.
+5. ``SyntaxError``: Syntactical error, such as ``continue`` is used outside of a ``for`` loop.
+6. ``DeclarationError``: Invalid, unresolvable or clashing identifier names. e.g. ``Identifier not found``
+7. ``TypeError``: Error within the type system, such as invalid type conversions, invalid assignments, etc.
+8. ``UnimplementedFeatureError``: Feature is not supported by the compiler, but is expected to be supported in future versions.
+9. ``InternalCompilerError``: Internal bug triggered in the compiler - this should be reported as an issue.
+10. ``Exception``: Unknown failure during compilation - this should be reported as an issue.
+11. ``CompilerError``: Invalid use of the compiler stack - this should be reported as an issue.
+12. ``FatalError``: Fatal error not processed correctly - this should be reported as an issue.
+13. ``Warning``: A warning, which didn't stop the compilation, but should be addressed if possible.