Skip to content

Commit

Permalink
attempt to fix docs
Browse files Browse the repository at this point in the history
  • Loading branch information
paulgessinger committed Feb 27, 2025
1 parent beb7038 commit c4aa5f6
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 16 deletions.
24 changes: 12 additions & 12 deletions Core/include/Acts/Geometry/BlueprintNode.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,11 @@ class LayerBlueprintNode;
/// structures
///
/// During the *build* phase, the `build` method of all nodes in the tree are
/// called recursively. Some nodes, like @ref Acts::CylinderContainerBlueprintNode,
/// called recursively. Some nodes, like @ref Acts::Experimental::CylinderContainerBlueprintNode,
/// will take action on the volumes returns from its children, and perform
/// sizing to connect them. See the @ref Acts::CylinderContainerBlueprintNode and @ref
/// Acts::CylinderVolumeStack documentation for details on how the sizing is
/// carried out.
/// sizing to connect them. See the @ref Acts::Experimental::CylinderContainerBlueprintNode
/// and @ref Acts::Experimental::CylinderVolumeStack documentation for details on how the
/// sizing is carried out.
class BlueprintNode {
public:
/// Virtual destructor to ensure correct cleanup
Expand All @@ -75,7 +75,7 @@ class BlueprintNode {
///
/// @note Generally, you should not need to to call this method directly.
/// The construction should usually be done through the special
/// @ref Acts::Blueprint class.
/// @ref Acts::Experimental::Blueprint class.
///
/// @param options The global construction options
/// @param gctx The geometry context for construction (usually nominal)
Expand All @@ -92,7 +92,7 @@ class BlueprintNode {
/// Each boundary surface is then turned into a @ref Acts::TrivialPortalLink, which
/// in turn produces a one-sided portal (see @ref Acts::Portal documentation)
///
/// Some nodes (like @ref Acts::CylinderContainerBlueprintNode) will take action on
/// Some nodes (like @ref Acts::Experimental::CylinderContainerBlueprintNode) will take action on
/// their children, and unify the connected portals.
///
/// After a node's processing has completed, it returns a reference to a @ref
Expand Down Expand Up @@ -122,7 +122,7 @@ class BlueprintNode {
/// argument**, rather than being implicitly determined from the
/// **parent node**. This is done so that nodes can remove themselves
/// from the final volume hierarchy, like container nodes or the
/// @ref Acts::MaterialDesignatorBlueprintNode.
/// @ref Acts::Experimental::MaterialDesignatorBlueprintNode.
///
/// @param options The global construction options
/// @param gctx The geometry context for construction (usually nominal)
Expand Down Expand Up @@ -166,7 +166,7 @@ class BlueprintNode {
///
/// @{

/// This method creates a new @ref Acts::StaticBlueprintNode wrapping @p
/// This method creates a new @ref Acts::Experimental::StaticBlueprintNode wrapping @p
/// volume and adds it to this node as a child.
/// @param volume The volume to add
/// @param callback An optional callback that receives the node as an argument
Expand All @@ -175,7 +175,7 @@ class BlueprintNode {
std::unique_ptr<TrackingVolume> volume,
const std::function<void(StaticBlueprintNode& cylinder)>& callback = {});

/// Alternative overload for creating a @ref Acts::StaticBlueprintNode. This
/// Alternative overload for creating a @ref Acts::Experimental::StaticBlueprintNode. This
/// overload will invoke the constructor of @ref Acts::TrackingVolume and use
/// that volume to create the node.
/// @param transform The transform of the volume
Expand All @@ -187,7 +187,7 @@ class BlueprintNode {
const std::string& volumeName = "undefined",
const std::function<void(StaticBlueprintNode& cylinder)>& callback = {});

/// Convenience method for creating a @ref Acts::CylinderContainerBlueprintNode.
/// Convenience method for creating a @ref Acts::Experimental::CylinderContainerBlueprintNode.
/// @param name The name of the container node. This name is only reflected
/// in the node tree for debugging, as no extra volumes is created
/// for the container.
Expand All @@ -199,7 +199,7 @@ class BlueprintNode {
const std::function<void(CylinderContainerBlueprintNode& cylinder)>&
callback = {});

/// Convenience method for creating a @ref Acts::MaterialDesignatorBlueprintNode.
/// Convenience method for creating a @ref Acts::Experimental::MaterialDesignatorBlueprintNode.
/// @param name The name of the material designator node. Used for debugging
/// the node tree only.
/// @param callback An optional callback that receives the node as an argument
Expand All @@ -208,7 +208,7 @@ class BlueprintNode {
const std::function<void(MaterialDesignatorBlueprintNode& material)>&
callback = {});

/// Convenience method for creating a @ref Acts::LayerBlueprintNode.
/// Convenience method for creating a @ref Acts::Experimental::LayerBlueprintNode.
/// @param name The name of the layer node.
/// @param callback An optional callback that receives the node as an argument
LayerBlueprintNode& addLayer(
Expand Down
8 changes: 4 additions & 4 deletions Core/include/Acts/Geometry/LayerBlueprintNode.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -18,13 +18,13 @@ namespace Acts::Experimental {
/// surfaces.
/// @note This implementation is **preliminary** and will likely change
/// in the future.
/// It defers most of the functionality to @ref Acts::StaticBlueprintNode,
/// It defers most of the functionality to @ref Acts::Experimental::StaticBlueprintNode,
/// after the initial volume creation is completed.
///
/// The layer volume is created to wrap around the surfaces registered with
/// this node. The orientation of the resulting volume defaults to the identity
/// matrix. If another orientation is desired, this can be set with the @ref
/// Acts::LayerBlueprintNode::setTransform. See @ref Acts::ProtoLayer for
/// Acts::Experimental::LayerBlueprintNode::setTransform. See @ref Acts::ProtoLayer for
/// details on the auto-sizing from surfaces.
///
class LayerBlueprintNode : public StaticBlueprintNode {
Expand Down Expand Up @@ -56,7 +56,7 @@ class LayerBlueprintNode : public StaticBlueprintNode {
/// -# Register the surfaces with the volume
/// -# Return the volume
/// @note At least one surfaces needs to be registered via
/// @ref Acts::LayerBlueprintNode::setSurfaces before
/// @ref Acts::Experimental::LayerBlueprintNode::setSurfaces before
/// geometry construction.
Volume& build(const BlueprintOptions& options, const GeometryContext& gctx,
const Logger& logger = Acts::getDummyLogger()) override;
Expand Down Expand Up @@ -121,7 +121,7 @@ class LayerBlueprintNode : public StaticBlueprintNode {
}

private:
/// @copydoc Acts::BlueprintNode::addToGraphviz
/// @copydoc Acts::Experimental::BlueprintNode::addToGraphviz
void addToGraphviz(std::ostream& os) const override;

/// Helper method that performs the volume creation from the configured
Expand Down

0 comments on commit c4aa5f6

Please sign in to comment.