Skip to content

Commit 583ace5

Browse files
authored
docs: fix formatting examples for version macros (#5073)
The comments that explain how to use the OIIO_MAKE_VERSION and related macros actually were using formatting that would have been rejected by our own clang-format settings. Change those examples so that they use the correct formatting that woule be accepted by the project. Signed-off-by: Larry Gritz <lg@larrygritz.com>
1 parent f1b399b commit 583ace5

1 file changed

Lines changed: 3 additions & 3 deletions

File tree

src/include/OpenImageIO/oiioversion.h.in

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -55,7 +55,7 @@
5555
// Construct a single integer version number from major, minor, patch.
5656
// Example of its use:
5757
//
58-
// #if OIIO_VERSION >= OIIO_MAKE_VERSION(2,3,0)
58+
// #if OIIO_VERSION >= OIIO_MAKE_VERSION(2, 3, 0)
5959
// ... use a feature introduced in version 2.3.0 ...
6060
// #endif
6161
//
@@ -96,7 +96,7 @@
9696
// were deprecated as of that version may be hidden from view of software
9797
// including the OIIO headers. For example, if a downstream project says
9898
//
99-
// #define OIIO_DISABLE_DEPRECATED OIIO_MAKE_VERSION(2,2,0)
99+
// #define OIIO_DISABLE_DEPRECATED OIIO_MAKE_VERSION(2, 2, 0)
100100
//
101101
// before including any OpenImageIO header, then we will do our best to make
102102
// it a compile-time error if they try to use anything that was deprecated
@@ -108,7 +108,7 @@
108108
// To clarify, if version 2.2 is the first to deprecate a certain definition,
109109
// then it is considered good practice to guard it like this:
110110
//
111-
// #if OIIO_DISABLE_DEPRECATED < OIIO_MAKE_VERSION(2,2,0)
111+
// #if OIIO_DISABLE_DEPRECATED < OIIO_MAKE_VERSION(2, 2, 0)
112112
// ... deprecated definition here ...
113113
// #endif
114114
//

0 commit comments

Comments
 (0)