Skip to content

Commit

Permalink
fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
andiwand committed Nov 25, 2024
1 parent 1938235 commit c701aab
Show file tree
Hide file tree
Showing 4 changed files with 32 additions and 16 deletions.
12 changes: 8 additions & 4 deletions Core/include/Acts/Material/HomogeneousSurfaceMaterial.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -90,10 +90,14 @@ class HomogeneousSurfaceMaterial : public ISurfaceMaterial {
/// The five different MaterialSlab
MaterialSlab m_fullMaterial;

/// Check if two materials are exactly equal.
/// @note This is a strict equality check, i.e. the materials must
/// have identical properties.
/// @param other is the material to compare to
/// @brief Check if two materials are exactly equal.
///
/// This is a strict equality check, i.e. the materials must have identical
/// properties.
///
/// @param lhs is the left hand side material
/// @param rhs is the right hand side material
///
/// @return true if the materials are equal
friend constexpr bool operator==(const HomogeneousSurfaceMaterial& lhs,
const HomogeneousSurfaceMaterial& rhs) {
Expand Down
12 changes: 8 additions & 4 deletions Core/include/Acts/Material/HomogeneousVolumeMaterial.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -61,10 +61,14 @@ class HomogeneousVolumeMaterial : public IVolumeMaterial {
private:
Material m_material;

/// Check if two materials are exactly equal.
/// @note This is a strict equality check, i.e. the materials must
/// have identical properties.
/// @param other is the material to compare to
/// @brief Check if two materials are exactly equal.
///
/// This is a strict equality check, i.e. the materials must have identical
/// properties.
///
/// @param lhs is the left hand side material
/// @param rhs is the right hand side material
///
/// @return true if the materials are equal
friend constexpr bool operator==(const HomogeneousVolumeMaterial& lhs,
const HomogeneousVolumeMaterial& rhs) {
Expand Down
12 changes: 8 additions & 4 deletions Core/include/Acts/Material/Material.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -111,10 +111,14 @@ class Material {
float m_z = 0.0f;
float m_molarRho = 0.0f;

/// Check if two materials are exactly equal.
/// @note This is a strict equality check, i.e. the materials must
/// have identical properties.
/// @param mat is the material to compare to
/// @brief Check if two materials are exactly equal.
///
/// This is a strict equality check, i.e. the materials must have identical
/// properties.
///
/// @param lhs is the left hand side material
/// @param rhs is the right hand side material
///
/// @return true if the materials are equal
friend constexpr bool operator==(const Material& lhs, const Material& rhs) {
return (lhs.m_x0 == rhs.m_x0) && (lhs.m_l0 == rhs.m_l0) &&
Expand Down
12 changes: 8 additions & 4 deletions Core/include/Acts/Material/MaterialSlab.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -79,10 +79,14 @@ class MaterialSlab {
float m_thicknessInX0 = 0.0f;
float m_thicknessInL0 = 0.0f;

/// Check if two materials are exactly equal.
/// @note This is a strict equality check, i.e. the materials must
/// have identical properties.
/// @param other is the material to compare to
/// @brief Check if two materials are exactly equal.
///
/// This is a strict equality check, i.e. the materials must have identical
/// properties.
///
/// @param lhs is the left hand side material
/// @param rhs is the right hand side material
///
/// @return true if the materials are equal
friend constexpr bool operator==(const MaterialSlab& lhs,
const MaterialSlab& rhs) {
Expand Down

0 comments on commit c701aab

Please sign in to comment.