aboutsummaryrefslogtreecommitdiff
path: root/libcrystfel
diff options
context:
space:
mode:
authorThomas White <taw@physics.org>2020-07-02 16:28:12 +0200
committerThomas White <taw@physics.org>2020-07-29 18:53:44 +0200
commit518414e0a3d248bbc182da69308144b79d646510 (patch)
treef915f2c2fce4e32ba2f4d51e4d984ae1da11892c /libcrystfel
parent60a2dc90d0735f75277804822ca33e23ff19a0f5 (diff)
Update comments
Diffstat (limited to 'libcrystfel')
-rw-r--r--libcrystfel/src/stream.c4
-rw-r--r--libcrystfel/src/stream.h3
2 files changed, 5 insertions, 2 deletions
diff --git a/libcrystfel/src/stream.c b/libcrystfel/src/stream.c
index 4b3696d5..b3ac10aa 100644
--- a/libcrystfel/src/stream.c
+++ b/libcrystfel/src/stream.c
@@ -77,7 +77,7 @@ struct _stream
* indexing method */
int in_chunk; /* True if a chunk start marker has been "accidentally"
- * encountered, so read_chunk() should assume a chunk is
+ * encountered, so stream_read_chunk() should assume a chunk is
* already in progress instead of looking for another
* marker */
};
@@ -1386,7 +1386,7 @@ void stream_write_geometry_file(Stream *st, const char *geom_filename)
* \param st A \ref Stream
*
* Attempts to set the file pointer for \p st to the start of the stream, so that
- * later calls to \ref read_chunk will repeat the sequence of chunks from the
+ * later calls to \ref stream_read_chunk will repeat the sequence of chunks from the
* start.
*
* Programs must not assume that this operation always succeeds!
diff --git a/libcrystfel/src/stream.h b/libcrystfel/src/stream.h
index 6970ea02..43881ecf 100644
--- a/libcrystfel/src/stream.h
+++ b/libcrystfel/src/stream.h
@@ -107,13 +107,16 @@ extern void stream_write_commandline_args(Stream *st,
extern void stream_write_indexing_methods(Stream *st,
const char *indm_str);
+/* Metadata */
extern int stream_has_old_indexers(Stream *st);
extern char *stream_audit_info(Stream *st);
extern char *stream_geometry_file(Stream *st);
+/* Low-level stuff used for indexamajig sandbox */
extern int stream_get_fd(Stream *st);
extern int stream_rewind(Stream *st);
+/* Read/write chunks */
extern struct image *stream_read_chunk(Stream *st,
const DataTemplate *dtempl,
StreamFlags srf);