Skip to content

Commit 6143d3e

Browse files
committed
Explain why detail::View symbols are visible (#788)
Signed-off-by: Ashton Larkin <[email protected]>
1 parent f4a3ea4 commit 6143d3e

File tree

1 file changed

+5
-0
lines changed
  • include/ignition/gazebo/detail

1 file changed

+5
-0
lines changed

include/ignition/gazebo/detail/View.hh

+5
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,11 @@ using ComponentTypeKey = std::set<ComponentTypeId>;
4545
/// use a cache to improve performance. The assumption is that entities
4646
/// and the types of components assigned to entities change infrequently
4747
/// compared to the frequency of queries performed by systems.
48+
///
49+
/// Note that symbols for this class are visible because methods from this class
50+
/// are used in templated Ignition::Gazebo::EntityComponentManager methods.
51+
/// However, users should not use this class (or anything else in namespace
52+
/// ignition::gazebo::detail) directly.
4853
class IGNITION_GAZEBO_VISIBLE View
4954
{
5055
/// Get a pointer to a component for an entity based on a component type.

0 commit comments

Comments
 (0)