Skip to content

Commit a271760

Browse files
authored
Adsk Contrib - Same API cleanup (#1204)
Signed-off-by: Patrick Hodoul <Patrick.Hodoul@autodesk.com>
1 parent 8671060 commit a271760

5 files changed

Lines changed: 66 additions & 75 deletions

File tree

include/OpenColorIO/OpenColorIO.h

Lines changed: 13 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1039,7 +1039,7 @@ class OCIOEXPORT Config
10391039
Config(const Config &) = delete;
10401040
Config& operator= (const Config &) = delete;
10411041

1042-
// Do not use (needed only for pybind11).
1042+
/// Do not use (needed only for pybind11).
10431043
~Config();
10441044

10451045
//!cpp:function:: Control the caching of processors in the config instance. By default, caching
@@ -1120,7 +1120,7 @@ extern OCIOEXPORT std::ostream& operator<< (std::ostream&, const Config&);
11201120
// getter will return NULL and setter will throw.
11211121
//
11221122

1123-
class FileRules
1123+
class OCIOEXPORT FileRules
11241124
{
11251125
public:
11261126
/**
@@ -1215,7 +1215,7 @@ class FileRules
12151215
FileRules(const FileRules &) = delete;
12161216
FileRules & operator= (const FileRules &) = delete;
12171217

1218-
// Do not use (needed only for pybind11).
1218+
/// Do not use (needed only for pybind11).
12191219
virtual ~FileRules();
12201220

12211221
private:
@@ -1259,7 +1259,7 @@ extern OCIOEXPORT std::ostream & operator<< (std::ostream &, const FileRules &);
12591259
// Getters and setters are using the rule position, they will throw if the position is not
12601260
// valid.
12611261

1262-
class ViewingRules
1262+
class OCIOEXPORT ViewingRules
12631263
{
12641264
public:
12651265
/// Creates ViewingRules for a Config.
@@ -1338,7 +1338,7 @@ class ViewingRules
13381338

13391339
ViewingRules(const ViewingRules &) = delete;
13401340
ViewingRules & operator= (const ViewingRules &) = delete;
1341-
// Do not use (needed only for pybind11).
1341+
/// Do not use (needed only for pybind11).
13421342
virtual ~ViewingRules();
13431343

13441344
private:
@@ -1545,7 +1545,7 @@ class OCIOEXPORT ColorSpace
15451545

15461546
ColorSpace(const ColorSpace &) = delete;
15471547
ColorSpace& operator= (const ColorSpace &) = delete;
1548-
// Do not use (needed only for pybind11).
1548+
/// Do not use (needed only for pybind11).
15491549
~ColorSpace();
15501550

15511551
private:
@@ -1664,7 +1664,7 @@ class OCIOEXPORT ColorSpaceSet
16641664
/// Clear all color spaces.
16651665
void clearColorSpaces();
16661666

1667-
//!cpp:function:: Do not use (needed only for pybind11).
1667+
/// Do not use (needed only for pybind11).
16681668
~ColorSpaceSet();
16691669

16701670
private:
@@ -1756,11 +1756,9 @@ class OCIOEXPORT Look
17561756
const char * getDescription() const;
17571757
void setDescription(const char * description);
17581758

1759-
//!cpp:function::
17601759
Look(const Look &) = delete;
1761-
//!cpp:function::
17621760
Look& operator= (const Look &) = delete;
1763-
//!cpp:function:: Do not use (needed only for pybind11).
1761+
/// Do not use (needed only for pybind11).
17641762
~Look();
17651763

17661764
private:
@@ -1842,7 +1840,6 @@ class OCIOEXPORT ViewTransform
18421840

18431841
ViewTransform(const ViewTransform &) = delete;
18441842
ViewTransform & operator= (const ViewTransform &) = delete;
1845-
18461843
/// Do not use (needed only for pybind11).
18471844
~ViewTransform();
18481845

@@ -2016,11 +2013,9 @@ class OCIOEXPORT Processor
20162013
BitDepth outBitDepth,
20172014
OptimizationFlags oFlags) const;
20182015

2019-
//!cpp:function::
20202016
Processor(const Processor &) = delete;
2021-
//!cpp:function::
20222017
Processor & operator= (const Processor &) = delete;
2023-
//!cpp:function:: Do not use (needed only for pybind11).
2018+
/// Do not use (needed only for pybind11).
20242019
~Processor();
20252020

20262021
private:
@@ -2092,11 +2087,9 @@ class OCIOEXPORT CPUProcessor
20922087
void applyRGB(float * pixel) const;
20932088
void applyRGBA(float * pixel) const;
20942089

2095-
//!cpp:function::
20962090
CPUProcessor(const CPUProcessor &) = delete;
2097-
//!cpp:function::
20982091
CPUProcessor& operator= (const CPUProcessor &) = delete;
2099-
//!cpp:function:: Do not use (needed only for pybind11).
2092+
/// Do not use (needed only for pybind11).
21002093
~CPUProcessor();
21012094

21022095
private:
@@ -2131,11 +2124,9 @@ class OCIOEXPORT GPUProcessor
21312124
/// Extract the shader information using a custom \ref GpuShaderCreator class.
21322125
void extractGpuShaderInfo(GpuShaderCreatorRcPtr & shaderCreator) const;
21332126

2134-
//!cpp:function::
21352127
GPUProcessor(const GPUProcessor &) = delete;
2136-
//!cpp:function::
21372128
GPUProcessor& operator= (const GPUProcessor &) = delete;
2138-
//!cpp:function:: Do not use (needed only for pybind11).
2129+
/// Do not use (needed only for pybind11).
21392130
~GPUProcessor();
21402131

21412132
private:
@@ -2173,11 +2164,9 @@ class OCIOEXPORT ProcessorMetadata
21732164
void addFile(const char * fname);
21742165
void addLook(const char * look);
21752166

2176-
//!cpp:function::
21772167
ProcessorMetadata(const ProcessorMetadata &) = delete;
2178-
//!cpp:function::
21792168
ProcessorMetadata& operator= (const ProcessorMetadata &) = delete;
2180-
//!cpp:function:: Do not use (needed only for pybind11).
2169+
/// Do not use (needed only for pybind11).
21812170
~ProcessorMetadata();
21822171

21832172
private:
@@ -2304,11 +2293,9 @@ class OCIOEXPORT Baker
23042293
*/
23052294
static const char * getFormatExtensionByIndex(int index);
23062295

2307-
//!cpp:function::
23082296
Baker(const Baker &) = delete;
2309-
//!cpp:function::
23102297
Baker& operator= (const Baker &) = delete;
2311-
//!cpp:function:: Do not use (needed only for pybind11).
2298+
/// Do not use (needed only for pybind11).
23122299
~Baker();
23132300

23142301
private:
@@ -2737,7 +2724,6 @@ class OCIOEXPORT GpuShaderCreator
27372724

27382725
GpuShaderCreator(const GpuShaderCreator &) = delete;
27392726
GpuShaderCreator & operator= (const GpuShaderCreator &) = delete;
2740-
27412727
/// Do not use (needed only for pybind11).
27422728
virtual ~GpuShaderCreator();
27432729

@@ -2979,7 +2965,6 @@ class OCIOEXPORT GpuShaderDesc : public GpuShaderCreator
29792965

29802966
GpuShaderDesc(const GpuShaderDesc &) = delete;
29812967
GpuShaderDesc& operator= (const GpuShaderDesc &) = delete;
2982-
29832968
/// Do not use (needed only for pybind11).
29842969
virtual ~GpuShaderDesc();
29852970

@@ -3098,7 +3083,6 @@ class OCIOEXPORT Context
30983083

30993084
Context(const Context &) = delete;
31003085
Context& operator= (const Context &) = delete;
3101-
31023086
/// Do not use (needed only for pybind11).
31033087
~Context();
31043088

0 commit comments

Comments
 (0)