aboutsummaryrefslogtreecommitdiffstats
path: root/include
diff options
context:
space:
mode:
authorJay Berkenbilt <ejb@ql.org>2018-01-24 03:48:13 +0100
committerJay Berkenbilt <ejb@ql.org>2018-01-29 00:29:47 +0100
commitaa2cfad61a1c51e15571c77a8cf70aa872140aca (patch)
treeff9755d2887e08d41281a0d1d61c6438e7487d82 /include
parent2e4ca7ecf465efda799907c2554870e4f9dc6679 (diff)
downloadqpdf-aa2cfad61a1c51e15571c77a8cf70aa872140aca.tar.zst
Clarify some comments
Diffstat (limited to 'include')
-rw-r--r--include/qpdf/BufferInputSource.hh2
-rw-r--r--include/qpdf/InputSource.hh6
2 files changed, 5 insertions, 3 deletions
diff --git a/include/qpdf/BufferInputSource.hh b/include/qpdf/BufferInputSource.hh
index 783c436e..954ffe36 100644
--- a/include/qpdf/BufferInputSource.hh
+++ b/include/qpdf/BufferInputSource.hh
@@ -28,6 +28,8 @@
class BufferInputSource: public InputSource
{
public:
+ // If own_memory is true, BufferInputSource will delete the buffer
+ // when finished with it. Otherwise, the caller owns the memory.
QPDF_DLL
BufferInputSource(std::string const& description, Buffer* buf,
bool own_memory = false);
diff --git a/include/qpdf/InputSource.hh b/include/qpdf/InputSource.hh
index 87201e72..2fd95977 100644
--- a/include/qpdf/InputSource.hh
+++ b/include/qpdf/InputSource.hh
@@ -64,9 +64,9 @@ class InputSource
// starting within the range defined by offset and len such that,
// when the input source is positioned at the beginning of that
// sequence, finder.check() returns true. If len is 0, the search
- // proceeds until EOF. If a qualifying pattern these methods
- // return true and leave the input source positioned wherever
- // check() left it at the end of the matching pattern.
+ // proceeds until EOF. If a qualifying pattern is found, these
+ // methods return true and leave the input source positioned
+ // wherever check() left it at the end of the matching pattern.
QPDF_DLL
bool findFirst(char const* start_chars,
qpdf_offset_t offset, size_t len,