Skip to content

Commit

Permalink
Fix documentation build (#1809)
Browse files Browse the repository at this point in the history
* Fix documentation build on Doxygen 1.9.7

Signed-off-by: Rémi Achard <[email protected]>

* Remove doxygen group names

Signed-off-by: Rémi Achard <[email protected]>

* Remove remaining doxygen group

Signed-off-by: Rémi Achard <[email protected]>

---------

Signed-off-by: Rémi Achard <[email protected]>
  • Loading branch information
remia committed Jun 29, 2023
1 parent 8e801dc commit 16b1802
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 54 deletions.
34 changes: 8 additions & 26 deletions include/OpenColorIO/OpenColorIO.h
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*
Expand Down Expand Up @@ -799,11 +798,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.
*
Expand Down Expand Up @@ -920,11 +916,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.)
*
Expand Down Expand Up @@ -1004,8 +997,6 @@ class OCIOEXPORT Config
*/
int instantiateDisplayFromICCProfile(const char * ICCProfileFilepath);

/** @} */

/**
* \brief
*
Expand Down Expand Up @@ -1153,8 +1144,7 @@ class OCIOEXPORT Config
void clearViewTransforms();

/**
* \defgroup Methods related to named transforms.
* @{
* Methods related to named transforms.
*/

/**
Expand Down Expand Up @@ -1197,8 +1187,6 @@ class OCIOEXPORT Config
/// Clear all named transforms.
void clearNamedTransforms();

/** @} */

//
// File Rules
//
Expand Down Expand Up @@ -2122,8 +2110,7 @@ class OCIOEXPORT ColorSpaceSet
const Impl * getImpl() const { return m_impl; }
};

/** \defgroup ColorSpaceSetOperators
* @{
/** ColorSpaceSetOperators
*/

/**
Expand Down Expand Up @@ -2163,8 +2150,6 @@ extern OCIOEXPORT ConstColorSpaceSetRcPtr operator&&(const ConstColorSpaceSetRcP
extern OCIOEXPORT ConstColorSpaceSetRcPtr operator-(const ConstColorSpaceSetRcPtr & lcss,
const ConstColorSpaceSetRcPtr & rcss);

/** @}*/


//
// Look
Expand Down Expand Up @@ -3740,8 +3725,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.
Expand All @@ -3758,8 +3742,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;
Expand Down
29 changes: 1 addition & 28 deletions include/OpenColorIO/OpenColorTypes.h
Original file line number Diff line number Diff line change
Expand Up @@ -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.
Expand Down Expand Up @@ -776,12 +775,6 @@ extern OCIOEXPORT const char * OCIO_OPTIMIZATION_FLAGS_ENVVAR;
*/
extern OCIOEXPORT const char * OCIO_USER_CATEGORIES_ENVVAR;

/** @}*/

/** \defgroup VarsRoles
* @{
*/

// TODO: Move to .rst
/*!rst::
Roles
Expand Down Expand Up @@ -852,12 +845,6 @@ extern OCIOEXPORT const char * ROLE_INTERCHANGE_SCENE;
*/
extern OCIOEXPORT const char * ROLE_INTERCHANGE_DISPLAY;

/** @}*/

/** \defgroup VarsSharedView
* @{
*/

/*!rst::
Shared View
***********
Expand All @@ -870,12 +857,6 @@ Shared View
*/
extern OCIOEXPORT const char * OCIO_VIEW_USE_DISPLAY_NAME;

/** @}*/

/** \defgroup VarsFormatMetadata
* @{
*/

// TODO: Move to .rst
/*!rst::
FormatMetadata
Expand Down Expand Up @@ -929,12 +910,6 @@ extern OCIOEXPORT const char * METADATA_NAME;
*/
extern OCIOEXPORT const char * METADATA_ID;

/** @}*/

/** \defgroup VarsCaches
* @{
*/

/*!rst::
Caches
******
Expand Down Expand Up @@ -963,8 +938,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.
Expand Down

0 comments on commit 16b1802

Please sign in to comment.