Skip to content

Commit 030949d

Browse files
committed
docs: Online docs improvements, mostly formatting (AcademySoftwareFoundation#4736, AcademySoftwareFoundation#4743)
Signed-off-by: Larry Gritz <[email protected]>
1 parent a73e3ce commit 030949d

File tree

4 files changed

+8
-5
lines changed

4 files changed

+8
-5
lines changed

src/doc/Doxyfile

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2193,12 +2193,13 @@ PREDEFINED = DOXYGEN_SHOULD_SKIP_THIS \
21932193
OIIO_CONST_FUNC= \
21942194
OIIO_MAYBE_UNUSED= \
21952195
OIIO_NODISCARD:= \
2196-
OIIO_DEPRECATED:=[[deprecated]] \
2196+
OIIO_DEPRECATED(x)=[[deprecated]] \
21972197
OIIO_FORMAT_DEPRECATED:= \
21982198
OIIO_FORCEINLINE=inline \
21992199
IMATH_HALF_H_=1 \
22002200
INCLUDED_IMATHVEC_H=1 \
22012201
INCLUDED_IMATHMATRIX_H=1 \
2202+
OIIO_ENABLE_IF(x)="std::enable_if_t<(x), int> = 0" \
22022203

22032204

22042205
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this

src/doc/requirements.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
sphinx >= 5.0
2-
breathe == 4.34.0
1+
sphinx >= 8.0
2+
breathe == 4.36.0
33
sphinx-tabs
4-
furo==2022.6.21
4+
furo==2024.8.6

src/doc/texturesys.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -178,7 +178,7 @@ structure:
178178

179179
- `int colortransformid` :
180180
If non-zero, specifies a color transformation to apply to the texels, a
181-
handle to a transform retrerieved `TextureSystem::get_colortransform_id()`.
181+
handle to a transform retrieved `TextureSystem::get_colortransform_id()`.
182182

183183

184184

src/include/OpenImageIO/span.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -95,6 +95,7 @@ class span {
9595
/// Copy constructor (copies the span pointer and length, NOT the data).
9696
constexpr span (const span &copy) noexcept = default;
9797

98+
#ifndef OIIO_DOXYGEN /* this declaration confuses doxygen */
9899
/// Copy constructor from a different extent (copies the span pointer and
99100
/// length, NOT the data). This allows for construction of `span<const T>`
100101
/// from `span<T>`, and for converting fixed extent to dynamic extent.
@@ -104,6 +105,7 @@ class span {
104105
&& (extent == dynamic_extent || extent == N))>
105106
constexpr span (const span<U,N> &copy) noexcept
106107
: m_data(copy.data()), m_size(copy.size()) { }
108+
#endif
107109

108110
/// Construct from T* and length.
109111
constexpr span (pointer data, size_type size) noexcept

0 commit comments

Comments
 (0)