Skip to content

Commit

Permalink
Fix documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
sethrj committed Aug 16, 2023
1 parent 1eeca28 commit 93264f5
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
5 changes: 3 additions & 2 deletions src/orange/surf/SurfaceTransformer.hh
Original file line number Diff line number Diff line change
Expand Up @@ -16,10 +16,11 @@ namespace celeritas
{
//---------------------------------------------------------------------------//
/*!
* Apply a translation to a surface to get another surface.
* Apply a transformation to a surface to get another surface.
*
* The transform gives the new origin and rotation for the surface: rotation is
* applied first, then translation.
*
* A sphere centered about the origin will be translated to a a sphere with its
* center on the given point.
*/
Expand All @@ -29,7 +30,7 @@ class SurfaceTransformer
//! Construct with the transformation to apply
explicit SurfaceTransformer(Transformation const& trans) : tr_{trans} {}

//// TRANSFORMATIONS ////
//// SURFACE FUNCTIONS ////

template<Axis T>
Plane operator()(PlaneAligned<T> const&) const;
Expand Down
2 changes: 1 addition & 1 deletion src/orange/surf/SurfaceTranslator.hh
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ class SurfaceTranslator
//! Construct with the new origin of the surface
explicit SurfaceTranslator(Translation const& trans) : tr_{trans} {}

//// TRANSFORMATIONS ////
//// SURFACE FUNCTIONS ////

template<Axis T>
PlaneAligned<T> operator()(PlaneAligned<T> const&) const;
Expand Down

0 comments on commit 93264f5

Please sign in to comment.