AcademySoftwareFoundation
API documentation: python reference to classes
In C++ headers, when comment names another API class the produced documentation does create a link to that class documentation.
For instance, LogCameraTransform does reffer to LogAffineTransform:
If the Python bindings uses the same comment, no link is created. It seems that the class name would need to follow 'PyOpenColorIO.':
Is there a way to reuse the same documentation, or should we in that case maintain both the C++ and the Python documentation?
The C++ docs are being built by breathe in this case, and the Python docs by the code I wrote to extract the same Doxygen source for use in the Python bindings. That's why there is some difference. We should be able get to a matching state, but will require some refinement to the process. Some of these differences may work themselves out as the header docs are made more consistent as well.
