Skip to content

Commit

Permalink
Fix C++ doc generation
Browse files Browse the repository at this point in the history
  • Loading branch information
Wumpf committed Jul 18, 2024
1 parent b85cee3 commit 30fa07a
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 24 deletions.
24 changes: 12 additions & 12 deletions rerun_cpp/src/rerun/archetypes/transform3d.hpp

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

24 changes: 12 additions & 12 deletions rerun_cpp/src/rerun/archetypes/transform3d_ext.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,7 @@ namespace rerun::archetypes {
/// Creates a new 3D transform from translation/rotation/scale.
///
/// \param translation_ \copydoc Transform3D::translation
/// \param rotation \copydoc Rotation represented either as a quaternion or axis + angle rotation.
/// \param rotation Rotation represented either as a quaternion or axis + angle rotation.
/// \param scale_ \copydoc Transform3D::scale
/// \param from_parent \copydoc datatypes::TranslationRotationScale3D::from_parent
Transform3D(
Expand All @@ -135,7 +135,7 @@ namespace rerun::archetypes {
/// Creates a new 3D transform from translation/rotation/uniform-scale.
///
/// \param translation_ \copydoc Transform3D::translation
/// \param rotation \copydoc Rotation represented either as a quaternion or axis + angle rotation.
/// \param rotation Rotation represented either as a quaternion or axis + angle rotation.
/// \param uniform_scale Uniform scale factor that is applied to all axis equally.
/// \param from_parent \copydoc datatypes::TranslationRotationScale3D::from_parent
///
Expand All @@ -150,7 +150,7 @@ namespace rerun::archetypes {
/// From a translation, applied after a rotation & scale, known as an affine transformation.
///
/// \param translation \copydoc Transform3D::translation
/// \param rotation \copydoc Rotation represented either as a quaternion or axis + angle rotation.
/// \param rotation Rotation represented either as a quaternion or axis + angle rotation.
/// \param scale \copydoc Transform3D::scale
static Transform3D from_translation_rotation_scale(
const components::Translation3D& translation, const Rotation3D& rotation,
Expand All @@ -162,7 +162,7 @@ namespace rerun::archetypes {
/// From a translation, applied after a rotation & scale, known as an affine transformation.
///
/// \param translation \copydoc Transform3D::translation
/// \param rotation \copydoc Rotation represented either as a quaternion or axis + angle rotation.
/// \param rotation Rotation represented either as a quaternion or axis + angle rotation.
/// \param uniform_scale Uniform scale factor that is applied to all axis equally.
static Transform3D from_translation_rotation_scale(
const components::Translation3D& translation, const Rotation3D& rotation,
Expand All @@ -174,7 +174,7 @@ namespace rerun::archetypes {
/// Creates a new rigid transform (translation & rotation only).
///
/// \param translation_ \copydoc Transform3D::translation
/// \param rotation \copydoc Rotation represented either as a quaternion or axis + angle rotation.
/// \param rotation Rotation represented either as a quaternion or axis + angle rotation.
/// \param from_parent \copydoc datatypes::TranslationRotationScale3D::from_parent
Transform3D(
const components::Translation3D& translation_, const Rotation3D& rotation,
Expand All @@ -188,7 +188,7 @@ namespace rerun::archetypes {
/// From a rotation & scale.
///
/// \param translation \copydoc Transform3D::translation
/// \param rotation \copydoc Rotation represented either as a quaternion or axis + angle rotation.
/// \param rotation Rotation represented either as a quaternion or axis + angle rotation.
static Transform3D from_translation_rotation(
const components::Translation3D& translation, const Rotation3D& rotation
) {
Expand Down Expand Up @@ -233,7 +233,7 @@ namespace rerun::archetypes {

/// From rotation & scale.
///
/// \param rotation \copydoc Rotation represented either as a quaternion or axis + angle rotation.
/// \param rotation Rotation represented either as a quaternion or axis + angle rotation.
/// \param scale_ Transform3D::scale
/// \param from_parent \copydoc datatypes::TranslationRotationScale3D::from_parent
Transform3D(
Expand All @@ -246,7 +246,7 @@ namespace rerun::archetypes {

/// From rotation & uniform scale.
///
/// \param rotation \copydoc Rotation represented either as a quaternion or axis + angle rotation.
/// \param rotation Rotation represented either as a quaternion or axis + angle rotation.
/// \param uniform_scale Uniform scale factor that is applied to all axis equally.
/// \param from_parent \copydoc datatypes::TranslationRotationScale3D::from_parent
///
Expand All @@ -257,7 +257,7 @@ namespace rerun::archetypes {

/// From a rotation & scale.
///
/// \param rotation \copydoc Rotation represented either as a quaternion or axis + angle rotation.
/// \param rotation Rotation represented either as a quaternion or axis + angle rotation.
/// \param scale Transform3D::scale
static Transform3D from_rotation_scale(
const Rotation3D& rotation, const components::Scale3D& scale
Expand All @@ -267,15 +267,15 @@ namespace rerun::archetypes {

/// From a rotation & uniform scale.
///
/// \param rotation \copydoc Rotation represented either as a quaternion or axis + angle rotation.
/// \param rotation Rotation represented either as a quaternion or axis + angle rotation.
/// \param uniform_scale Uniform scale factor that is applied to all axis equally.
static Transform3D from_rotation_scale(const Rotation3D& rotation, float uniform_scale) {
return Transform3D(rotation, components::Scale3D(uniform_scale), false);
}

/// From rotation only.
///
/// \param rotation \copydoc Rotation represented either as a quaternion or axis + angle rotation.
/// \param rotation Rotation represented either as a quaternion or axis + angle rotation.
/// \param from_parent \copydoc datatypes::TranslationRotationScale3D::from_parent
Transform3D(const Rotation3D& rotation, bool from_parent = false)
: transform(datatypes::TranslationRotationScale3D(from_parent)) {
Expand All @@ -284,7 +284,7 @@ namespace rerun::archetypes {

/// From rotation only.
///
/// \param rotation \copydoc Rotation represented either as a quaternion or axis + angle rotation.
/// \param rotation Rotation represented either as a quaternion or axis + angle rotation.
static Transform3D from_rotation(const Rotation3D& rotation) {
return Transform3D(rotation, false);
}
Expand Down

0 comments on commit 30fa07a

Please sign in to comment.