Skip to content

Commit 3d8a3c7

Browse files
lgritzzachlewis
authored andcommitted
docs: Online docs improvements, mostly formatting (AcademySoftwareFoundation#4736)
Signed-off-by: Larry Gritz <lg@larrygritz.com>
1 parent d7fb30d commit 3d8a3c7

1 file changed

Lines changed: 5 additions & 5 deletions

File tree

src/include/OpenImageIO/image_span.h

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ template<typename T, size_t Rank = 4> class image_span {
9898
// clang-format off
9999
/* clang_format gets confused by this */
100100

101-
/// Copy constructor from image_span<T> to image_span<const T>.
101+
/// Copy constructor from `image_span<T>` to `image_span<const T>`.
102102
template<typename U, size_t R,
103103
OIIO_ENABLE_IF((std::is_same_v<std::remove_const_t<T>, U>)
104104
&& std::is_const_v<T> && !std::is_const_v<U>
@@ -112,7 +112,7 @@ template<typename T, size_t Rank = 4> class image_span {
112112
}
113113
// clang-format on
114114

115-
/// Construct from span<T> and dimensions, assume contiguous strides.
115+
/// Construct from `span<T>` and dimensions, assume contiguous strides.
116116
image_span(span<T> data, uint32_t nchannels, uint32_t width,
117117
uint32_t height, uint32_t depth = 1)
118118
: image_span(data.data(), nchannels, width, height, depth)
@@ -126,7 +126,7 @@ template<typename T, size_t Rank = 4> class image_span {
126126
/// same strided data as the operand.
127127
image_span& operator=(const image_span& copy) = default;
128128

129-
/// image_span(x,y,z) returns a strided_ptr<T,1> for the pixel (x,y,z).
129+
/// image_span(x,y,z) returns a `strided_ptr<T,1>` for the pixel (x,y,z).
130130
/// The z can be omitted for 2D images. Note that the resulting
131131
/// strided_ptr can then have individual channels accessed with
132132
/// operator[]. This particular strided pointer has stride multiplier 1,
@@ -212,8 +212,8 @@ template<typename T, size_t Rank = 4> class image_span {
212212
ystride(), zstride(), m_chansize);
213213
}
214214

215-
/// Convert an image_span<T> to an image_span<std::byte> representing the
216-
/// same sized and strided memory pattern represented un-typed memory.
215+
/// Convert an `image_span<T>` to an image_span<std::byte> representing
216+
/// the same sized and strided memory pattern represented un-typed memory.
217217
/// Note that this will not work (be a compiler error) if T a const type.
218218
image_span<std::byte> as_writable_bytes_image_span() const noexcept
219219
{

0 commit comments

Comments
 (0)