Document that the ReadFileCallback should not emit exceptions

This commit is contained in:
Alex Beregszaszi 2017-04-21 14:44:52 +01:00
parent b7951be44a
commit c82a203206
2 changed files with 4 additions and 2 deletions

View File

@ -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"

View File

@ -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)
{