aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorAlex Beregszaszi <alex@rtfs.hu>2017-04-21 21:44:52 +0800
committerAlex Beregszaszi <alex@rtfs.hu>2017-04-22 21:08:28 +0800
commitc82a203206ff36be2aea0c1d1ef976ddf085d65a (patch)
treea05781e58713c07e4f54012b49254db2c171385c
parentb7951be44a978ba3eb1a99c429e5f73770bd0972 (diff)
downloaddexon-solidity-c82a203206ff36be2aea0c1d1ef976ddf085d65a.tar
dexon-solidity-c82a203206ff36be2aea0c1d1ef976ddf085d65a.tar.gz
dexon-solidity-c82a203206ff36be2aea0c1d1ef976ddf085d65a.tar.bz2
dexon-solidity-c82a203206ff36be2aea0c1d1ef976ddf085d65a.tar.lz
dexon-solidity-c82a203206ff36be2aea0c1d1ef976ddf085d65a.tar.xz
dexon-solidity-c82a203206ff36be2aea0c1d1ef976ddf085d65a.tar.zst
dexon-solidity-c82a203206ff36be2aea0c1d1ef976ddf085d65a.zip
Document that the ReadFileCallback should not emit exceptions
-rw-r--r--libsolidity/interface/CompilerStack.h3
-rw-r--r--libsolidity/interface/StandardCompiler.h3
2 files changed, 4 insertions, 2 deletions
diff --git a/libsolidity/interface/CompilerStack.h b/libsolidity/interface/CompilerStack.h
index a34a34bb..d46c99be 100644
--- a/libsolidity/interface/CompilerStack.h
+++ b/libsolidity/interface/CompilerStack.h
@@ -79,7 +79,8 @@ class CompilerStack: boost::noncopyable
{
public:
/// Creates a new compiler stack.
- /// @param _readFile callback to used to read files for import statements. Should return
+ /// @param _readFile callback to used to read files for import statements. Must return
+ /// and must not emit exceptions.
explicit CompilerStack(ReadFile::Callback const& _readFile = ReadFile::Callback());
/// Sets path remappings in the format "context:prefix=target"
diff --git a/libsolidity/interface/StandardCompiler.h b/libsolidity/interface/StandardCompiler.h
index 0b714834..dfaf88cd 100644
--- a/libsolidity/interface/StandardCompiler.h
+++ b/libsolidity/interface/StandardCompiler.h
@@ -38,7 +38,8 @@ class StandardCompiler: boost::noncopyable
{
public:
/// Creates a new StandardCompiler.
- /// @param _readFile callback to used to read files for import statements. Should return
+ /// @param _readFile callback to used to read files for import statements. Must return
+ /// and must not emit exceptions.
StandardCompiler(ReadFile::Callback const& _readFile = ReadFile::Callback())
: m_compilerStack(_readFile), m_readFile(_readFile)
{