From 4202a7122eea0c9321ab724a53ad33e38ec23b71 Mon Sep 17 00:00:00 2001 From: Larry Gritz Date: Fri, 26 Jun 2026 09:25:20 -0400 Subject: [PATCH] docs: correct Doxygen style comments in IOProxy Signed-off-by: Larry Gritz --- src/include/OpenImageIO/filesystem.h | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/src/include/OpenImageIO/filesystem.h b/src/include/OpenImageIO/filesystem.h index 1f4084d93d..7813e15ac7 100644 --- a/src/include/OpenImageIO/filesystem.h +++ b/src/include/OpenImageIO/filesystem.h @@ -429,15 +429,15 @@ class OIIO_UTIL_API IOProxy { virtual void close () { } virtual bool opened () const { return mode() != Closed; } virtual int64_t tell() const { return m_pos; } - // Seek to the position, returning true on success, false on failure. - // Note the difference between this and std::fseek() which returns 0 on - // success, and -1 on failure. + /// Seek to the position, returning true on success, false on failure. + /// Note the difference between this and std::fseek() which returns 0 on + /// success, and -1 on failure. virtual bool seek (int64_t offset) { m_pos = offset; return true; } - // Read `size` bytes at the current position into `buf[]`, returning the - // number of bytes successfully read. + /// Read `size` bytes at the current position into `buf[]`, returning the + /// number of bytes successfully read. virtual size_t read (void *buf, size_t size); - // Write `size` bytes from `buf[]` at the current position, returning the - // number of bytes successfully written. + /// Write `size` bytes from `buf[]` at the current position, returning the + /// number of bytes successfully written. virtual size_t write (const void *buf, size_t size); /// Read `size` bytes starting at the `offset` position into `buf[]`, @@ -454,7 +454,7 @@ class OIIO_UTIL_API IOProxy { /// other function of IOProxy. virtual size_t pwrite (const void *buf, size_t size, int64_t offset); - // Return the total size of the proxy data, in bytes. + /// Return the total size of the proxy data, in bytes. virtual size_t size () const { return 0; } virtual void flush() { }