Skip to content

Commit f2bd863

Browse files
authored
docs: Fix small typos in Portal docs (#4360)
Small fixes/improvements to `Portal` docs
1 parent 4d3d89d commit f2bd863

File tree

2 files changed

+5
-5
lines changed

2 files changed

+5
-5
lines changed

Core/include/Acts/Geometry/Portal.hpp

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -42,9 +42,9 @@ class PortalFusingException : public std::exception {
4242
/// portals that describes which volumes lie behind the portal in that
4343
/// direction. Portals use associated portal links to perform lookups of target
4444
/// volumes.
45-
/// Each portal has two links, and a corresponding surface. One link is
46-
/// associated with the direction along the surface's normal vector, and one
47-
/// with the opposite direction.
45+
/// Each portal has two links (at least one non-null), and a corresponding
46+
/// surface. One link is associated with the direction along the surface's
47+
/// normal vector, and one with the opposite direction.
4848
class Portal {
4949
public:
5050
/// Constructor for a portal from a single link
@@ -88,8 +88,8 @@ class Portal {
8888
};
8989

9090
/// Entry for the link along normal
91-
/// Entry for the link opposite normal
9291
Link alongNormal{};
92+
/// Entry for the link opposite normal
9393
Link oppositeNormal{};
9494
};
9595

Core/include/Acts/Geometry/PortalLinkBase.hpp

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ class GeometryContext;
2424

2525
/// PortalLinkBase is the abstract base class for all portal links.
2626
/// A portal link is a mapping between a surface and a point on the surface and
27-
/// a destination tracking volum.
27+
/// a destination tracking volume.
2828
/// The derived classes implement different ways to resolve a volume
2929
class PortalLinkBase {
3030
protected:

0 commit comments

Comments
 (0)