From f89486a3a14dc44cb36221e99de6fdf1b3381a14 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Achard?= Date: Tue, 30 May 2023 19:33:25 +0100 Subject: [PATCH 1/3] Fix documentation build on Doxygen 1.9.7 MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Rémi Achard --- include/OpenColorIO/OpenColorIO.h | 29 ++++++---------------------- include/OpenColorIO/OpenColorTypes.h | 25 +++++------------------- 2 files changed, 11 insertions(+), 43 deletions(-) diff --git a/include/OpenColorIO/OpenColorIO.h b/include/OpenColorIO/OpenColorIO.h index 738dc0b93c..6779e2f70f 100644 --- a/include/OpenColorIO/OpenColorIO.h +++ b/include/OpenColorIO/OpenColorIO.h @@ -799,11 +799,8 @@ class OCIOEXPORT Config const char * getRoleColorSpace(const char * roleName) const noexcept; /** - * \defgroup Methods related to displays and views. - * @{ - */ - - /** + * Methods related to displays and views. + * * The following methods only manipulate active displays and views. Active * displays and views are defined from an env. variable or from the config file. * @@ -920,11 +917,8 @@ class OCIOEXPORT Config /// Clear all the displays. void clearDisplays(); - /** @} */ - /** - * \defgroup Methods related to the Virtual Display. - * @{ + * Methods related to the Virtual Display. * * ... (See descriptions for the non-virtual methods above.) * @@ -1004,8 +998,6 @@ class OCIOEXPORT Config */ int instantiateDisplayFromICCProfile(const char * ICCProfileFilepath); - /** @} */ - /** * \brief * @@ -1153,8 +1145,7 @@ class OCIOEXPORT Config void clearViewTransforms(); /** - * \defgroup Methods related to named transforms. - * @{ + * Methods related to named transforms. */ /** @@ -1197,8 +1188,6 @@ class OCIOEXPORT Config /// Clear all named transforms. void clearNamedTransforms(); - /** @} */ - // // File Rules // @@ -2122,8 +2111,7 @@ class OCIOEXPORT ColorSpaceSet const Impl * getImpl() const { return m_impl; } }; -/** \defgroup ColorSpaceSetOperators - * @{ +/** ColorSpaceSetOperators */ /** @@ -2163,8 +2151,6 @@ extern OCIOEXPORT ConstColorSpaceSetRcPtr operator&&(const ConstColorSpaceSetRcP extern OCIOEXPORT ConstColorSpaceSetRcPtr operator-(const ConstColorSpaceSetRcPtr & lcss, const ConstColorSpaceSetRcPtr & rcss); -/** @}*/ - // // Look @@ -3740,8 +3726,7 @@ class OCIOEXPORT SystemMonitors virtual bool isSupported() const noexcept = 0; /** - * \defgroup Methods to access some information of the attached and active monitors. - * @{ + * Methods to access some information of the attached and active monitors. */ /// Get the number of active monitors reported by the operating system. @@ -3758,8 +3743,6 @@ class OCIOEXPORT SystemMonitors /// Get the ICC profile path associated to the monitor. virtual const char * getProfileFilepath(size_t idx) const = 0; - /** @} */ - protected: SystemMonitors() = default; virtual ~SystemMonitors() = default; diff --git a/include/OpenColorIO/OpenColorTypes.h b/include/OpenColorIO/OpenColorTypes.h index c400568eaa..0df8310e99 100644 --- a/include/OpenColorIO/OpenColorTypes.h +++ b/include/OpenColorIO/OpenColorTypes.h @@ -726,8 +726,7 @@ extern OCIOEXPORT ExposureContrastStyle ExposureContrastStyleFromString(const ch extern OCIOEXPORT const char * NegativeStyleToString(NegativeStyle style); extern OCIOEXPORT NegativeStyle NegativeStyleFromString(const char * style); -/** \defgroup Env. variables. - * @{ +/** Env. variables. * * These environmental variables are used by the OpenColorIO library. * For variables that allow specifying more than one token, they should be separated by commas. @@ -776,10 +775,7 @@ extern OCIOEXPORT const char * OCIO_OPTIMIZATION_FLAGS_ENVVAR; */ extern OCIOEXPORT const char * OCIO_USER_CATEGORIES_ENVVAR; -/** @}*/ - -/** \defgroup VarsRoles - * @{ +/** VarsRoles */ // TODO: Move to .rst @@ -852,10 +848,7 @@ extern OCIOEXPORT const char * ROLE_INTERCHANGE_SCENE; */ extern OCIOEXPORT const char * ROLE_INTERCHANGE_DISPLAY; -/** @}*/ - -/** \defgroup VarsSharedView - * @{ +/** VarsSharedView */ /*!rst:: @@ -870,10 +863,7 @@ Shared View */ extern OCIOEXPORT const char * OCIO_VIEW_USE_DISPLAY_NAME; -/** @}*/ - -/** \defgroup VarsFormatMetadata - * @{ +/** VarsFormatMetadata */ // TODO: Move to .rst @@ -929,10 +919,7 @@ extern OCIOEXPORT const char * METADATA_NAME; */ extern OCIOEXPORT const char * METADATA_ID; -/** @}*/ - -/** \defgroup VarsCaches - * @{ +/** VarsCaches */ /*!rst:: @@ -963,8 +950,6 @@ extern OCIOEXPORT const char * OCIO_DISABLE_PROCESSOR_CACHES; // variable to disable the fallback. extern OCIOEXPORT const char * OCIO_DISABLE_CACHE_FALLBACK; -/** @}*/ - // Archive config feature // Default filename (with extension) of an config. From c295a205899857b65d79a3aca0de77fb54080402 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Achard?= Date: Wed, 28 Jun 2023 19:56:47 +0100 Subject: [PATCH 2/3] Remove doxygen group names MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Rémi Achard --- include/OpenColorIO/OpenColorTypes.h | 12 ------------ 1 file changed, 12 deletions(-) diff --git a/include/OpenColorIO/OpenColorTypes.h b/include/OpenColorIO/OpenColorTypes.h index 0df8310e99..5e28bbb175 100644 --- a/include/OpenColorIO/OpenColorTypes.h +++ b/include/OpenColorIO/OpenColorTypes.h @@ -775,9 +775,6 @@ extern OCIOEXPORT const char * OCIO_OPTIMIZATION_FLAGS_ENVVAR; */ extern OCIOEXPORT const char * OCIO_USER_CATEGORIES_ENVVAR; -/** VarsRoles - */ - // TODO: Move to .rst /*!rst:: Roles @@ -848,9 +845,6 @@ extern OCIOEXPORT const char * ROLE_INTERCHANGE_SCENE; */ extern OCIOEXPORT const char * ROLE_INTERCHANGE_DISPLAY; -/** VarsSharedView - */ - /*!rst:: Shared View *********** @@ -863,9 +857,6 @@ Shared View */ extern OCIOEXPORT const char * OCIO_VIEW_USE_DISPLAY_NAME; -/** VarsFormatMetadata - */ - // TODO: Move to .rst /*!rst:: FormatMetadata @@ -919,9 +910,6 @@ extern OCIOEXPORT const char * METADATA_NAME; */ extern OCIOEXPORT const char * METADATA_ID; -/** VarsCaches - */ - /*!rst:: Caches ****** From b90c9316a61c21a9923e3897034a492d54fde422 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?R=C3=A9mi=20Achard?= Date: Wed, 28 Jun 2023 20:29:54 +0100 Subject: [PATCH 3/3] Remove remaining doxygen group MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit Signed-off-by: Rémi Achard --- include/OpenColorIO/OpenColorIO.h | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/include/OpenColorIO/OpenColorIO.h b/include/OpenColorIO/OpenColorIO.h index 6779e2f70f..dafe119b46 100644 --- a/include/OpenColorIO/OpenColorIO.h +++ b/include/OpenColorIO/OpenColorIO.h @@ -756,9 +756,8 @@ class OCIOEXPORT Config const char * builtinColorSpaceName); /** - * \defgroup Methods related to Roles. - * @{ - * + * Methods related to Roles. + * * A role allows a config author to indicate that a given color space should be used * for a particular purpose. *