From c82a203206ff36be2aea0c1d1ef976ddf085d65a Mon Sep 17 00:00:00 2001 From: Alex Beregszaszi Date: Fri, 21 Apr 2017 14:44:52 +0100 Subject: Document that the ReadFileCallback should not emit exceptions --- libsolidity/interface/CompilerStack.h | 3 ++- libsolidity/interface/StandardCompiler.h | 3 ++- 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) { -- cgit