diff --git a/src/Gui/Inventor/SoFCTransform.h b/src/Gui/Inventor/SoFCTransform.h index 9e79f64c3c51..806377dd7029 100644 --- a/src/Gui/Inventor/SoFCTransform.h +++ b/src/Gui/Inventor/SoFCTransform.h @@ -30,6 +30,17 @@ namespace Gui { +/** + * @class SoFCTransform + * @brief A temporary workaround for coin3d/coin#534. + * + * This class is a workaround for a missing feature to reduce the OpenGL stack size. + * The issue was reported here: https://github.com/coin3d/coin/issues/534 + * And was merged here: https://github.com/coin3d/coin/pull/535 + * + * Once this feature is available in all supported versions of Coin3D, this class should + * be removed and all instances should revert to using SoTransform. + */ class GuiExport SoFCTransform : public SoTransform { using inherited = SoTransform;