Skip to content

Commit

Permalink
Clarify variable names and docs
Browse files Browse the repository at this point in the history
  • Loading branch information
jstone-lucasfilm authored Oct 7, 2024
1 parent def7db6 commit fbab4bc
Showing 1 changed file with 6 additions and 6 deletions.
12 changes: 6 additions & 6 deletions source/MaterialXCore/Element.h
Original file line number Diff line number Diff line change
Expand Up @@ -625,21 +625,21 @@ class MX_CORE_API Element : public std::enable_shared_from_this<Element>
/// criteria provided.
/// @param rhs Element to compare against
/// @param options Equivalence criteria
/// @param result Results of comparison if argument is specified.
/// @param results Results of comparison if argument is specified.
/// @return True if the elements are equivalent. False otherwise.
bool isEquivalent(ConstElementPtr rhs, const ElementEquivalenceOptions& options,
ElementEquivalenceResultVec* result = nullptr) const;
ElementEquivalenceResultVec* results = nullptr) const;

/// Return true if the attribute on a given element is equivalent
/// based on the equivalence criteria provided.
/// @param rhs Element to compare against
/// @param attributeName Name of attribute to compare
/// @param options Equivalence criteria
/// @param result Results of comparison if argument is specified.
/// @param results Results of comparison if argument is specified.
/// @return True if the attribute on the elements are equivalent. False otherwise.
virtual bool isAttributeEquivalent(ConstElementPtr rhs, const string& attributeName,
const ElementEquivalenceOptions& options,
ElementEquivalenceResultVec* result = nullptr) const;
ElementEquivalenceResultVec* results = nullptr) const;

/// @}
/// @name Traversal
Expand Down Expand Up @@ -1218,11 +1218,11 @@ class MX_CORE_API ValueElement : public TypedElement
/// @param rhs Element to compare against
/// @param attributeName Name of attribute to compare
/// @param options Equivalence criteria
/// @param result Results of comparison if argument is specified.
/// @param results Results of comparison if argument is specified.
/// @return True if the attribute on the elements are equivalent. False otherwise.
bool isAttributeEquivalent(ConstElementPtr rhs, const string& attributeName,
const ElementEquivalenceOptions& options,
ElementEquivalenceResultVec* result = nullptr) const override;
ElementEquivalenceResultVec* results = nullptr) const override;

/// @}
/// @name Validation
Expand Down

0 comments on commit fbab4bc

Please sign in to comment.