Skip to content

Commit

Permalink
Update Doxygen comments (#2186)
Browse files Browse the repository at this point in the history
This changelist updates the Doxygen comments for MaterialXGenShader classes, improving the consistency of generated API documentation.
  • Loading branch information
jstone-lucasfilm authored Jan 16, 2025
1 parent c5811b6 commit baa3595
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 1 deletion.
2 changes: 1 addition & 1 deletion source/MaterialXGenShader/HwShaderGenerator.h
Original file line number Diff line number Diff line change
Expand Up @@ -343,7 +343,7 @@ class MX_GENSHADER_API HwShaderGenerator : public ShaderGenerator
mutable ClosureContext _defEmission;
};

/// @class HwShaderGenerator
/// @class HwImplementation
/// Base class for HW node implementations.
class MX_GENSHADER_API HwImplementation : public ShaderNodeImpl
{
Expand Down
3 changes: 3 additions & 0 deletions source/MaterialXGenShader/Nodes/HwTransformNode.h
Original file line number Diff line number Diff line change
Expand Up @@ -34,6 +34,7 @@ class MX_GENSHADER_API HwTransformNode : public ShaderNodeImpl
static const string WORLD;
};

/// Vector transform implementation for hardware languages
class MX_GENSHADER_API HwTransformVectorNode : public HwTransformNode
{
public:
Expand All @@ -45,6 +46,7 @@ class MX_GENSHADER_API HwTransformVectorNode : public HwTransformNode
string getHomogeneousCoordinate() const override { return "0.0"; }
};

/// Point transform implementation for hardware languages
class MX_GENSHADER_API HwTransformPointNode : public HwTransformVectorNode
{
public:
Expand All @@ -54,6 +56,7 @@ class MX_GENSHADER_API HwTransformPointNode : public HwTransformVectorNode
string getHomogeneousCoordinate() const override { return "1.0"; }
};

/// Normal transform implementation for hardware languages
class MX_GENSHADER_API HwTransformNormalNode : public HwTransformNode
{
public:
Expand Down
2 changes: 2 additions & 0 deletions source/MaterialXGenShader/TypeDesc.h
Original file line number Diff line number Diff line change
Expand Up @@ -275,6 +275,8 @@ class MX_GENSHADER_API StructTypeDesc
vector<StructMemberTypeDesc> _members;
};

/// @class StructTypeDescRegistry
/// Helper class for struct type registration.
class MX_GENSHADER_API StructTypeDescRegistry
{
public:
Expand Down

0 comments on commit baa3595

Please sign in to comment.