From 97a02758998762fedec15505b89551a0f6feb804 Mon Sep 17 00:00:00 2001 From: "C. J. Howard" Date: Mon, 10 May 2021 17:14:50 +0800 Subject: [PATCH] Fix broken namespace links in coordinate systems documentation --- src/coordinates/ecliptic.hpp | 18 ++++++------------ src/coordinates/equatorial.hpp | 12 ++++++------ src/coordinates/horizontal.hpp | 12 ++++++------ 3 files changed, 18 insertions(+), 24 deletions(-) diff --git a/src/coordinates/ecliptic.hpp b/src/coordinates/ecliptic.hpp index 2277f61..534c46c 100644 --- a/src/coordinates/ecliptic.hpp +++ b/src/coordinates/ecliptic.hpp @@ -38,7 +38,7 @@ namespace rectangular { * @param ecl Obliquity of the ecliptic, in radians. * @return Rotation matrix. * - * @see coordinates::equatorial + * @see coordinates::rectangular::equatorial */ template math::matrix3 to_equatorial(T ecl); @@ -50,10 +50,7 @@ namespace rectangular { * @param ecl Obliquity of the ecliptic, in radians. * @return Rectangular coordinates in equatorial space. * - * @note If more than one point is being rotated, it is recommended to use the rotation matrix directly. - * - * @see coordinates::ecliptic::rectangular::to_equatorial(T) - * @see coordinates::equatorial + * @see coordinates::rectangular::equatorial */ template math::vector3 to_equatorial(const math::vector3& v, T ecl); @@ -66,7 +63,7 @@ namespace rectangular { * @param lst Local sidereal time, in radians. * @return Rotation matrix. * - * @see coordinates::horizontal + * @see coordinates::rectangular::horizontal */ template math::matrix3 to_horizontal(T ecl, T lat, T lst); @@ -80,10 +77,7 @@ namespace rectangular { * @param lst Local sidereal time, in radians. * @return Rectangular coordinates in local horizontal space. * - * @note If more than one point is being rotated, it is recommended to use the rotation matrix directly. - * - * @see coordinates::ecliptic::rectangular::to_horizontal(T, T, T) - * @see coordinates::horizontal + * @see coordinates::rectangular::horizontal */ template math::vector3 to_horizontal(const math::vector3& v, T ecl, T lat, T lst); @@ -104,7 +98,7 @@ namespace spherical { * @param ecl Obliquity of the ecliptic, in radians. * @return Spherical coordinates in equatorial space, in the ISO order of radial distance, declination (radians), and right ascension (radians). * - * @see coordinates::equatorial + * @see coordinates::spherical::equatorial */ template math::vector3 to_equatorial(const math::vector3& v, T ecl); @@ -118,7 +112,7 @@ namespace spherical { * @param lst Local sidereal time, in radians. * @return Spherical coordinates in local horizontal space, in the ISO order of radial distance, altitude (radians), and azimuth (radians). * - * @see coordinates::horizontal + * @see coordinates::spherical::horizontal */ template math::vector3 to_horizontal(const math::vector3& v, T ecl, T lat, T lst); diff --git a/src/coordinates/equatorial.hpp b/src/coordinates/equatorial.hpp index 30f86e3..cf0c8ac 100644 --- a/src/coordinates/equatorial.hpp +++ b/src/coordinates/equatorial.hpp @@ -38,7 +38,7 @@ namespace rectangular { * @param ecl Obliquity of the ecliptic, in radians. * @return Rotation matrix. * - * @see coordinates::ecliptic + * @see coordinates::rectangular::ecliptic */ template math::matrix3 to_ecliptic(T ecl); @@ -50,7 +50,7 @@ namespace rectangular { * @param ecl Obliquity of the ecliptic, in radians. * @return Rectangular coordinates in ecliptic space. * - * @see coordinates::ecliptic + * @see coordinates::rectangular::ecliptic */ template math::vector3 to_ecliptic(const math::vector3& v, T ecl); @@ -62,7 +62,7 @@ namespace rectangular { * @param lst Local sidereal time, in radians. * @return Rotation matrix. * - * @see coordinates::horizontal + * @see coordinates::rectangular::horizontal */ template math::matrix3 to_horizontal(T lat, T lst); @@ -75,7 +75,7 @@ namespace rectangular { * @param lst Local sidereal time, in radians. * @return Rectangular coordinates in local horizontal space. * - * @see coordinates::horizontal + * @see coordinates::rectangular::horizontal */ template math::vector3 to_horizontal(const math::vector3& v, T lat, T lst); @@ -96,7 +96,7 @@ namespace spherical { * @param ecl Obliquity of the ecliptic, in radians. * @return Spherical coordinates in ecliptic space, in the ISO order of radial distance, ecliptic latitude (radians), and ecliptic longitude (radians). * - * @see coordinates::ecliptic + * @see coordinates::spherical::ecliptic */ template math::vector3 to_ecliptic(const math::vector3& v, T ecl); @@ -109,7 +109,7 @@ namespace spherical { * @param lst Local sidereal time, in radians. * @return Spherical coordinates in local horizontal space, in the ISO order of radial distance, altitude (radians), and azimuth (radians). * - * @see coordinates::horizontal + * @see coordinates::spherical::horizontal */ template math::vector3 to_horizontal(const math::vector3& v, T lat, T lst); diff --git a/src/coordinates/horizontal.hpp b/src/coordinates/horizontal.hpp index 23f08ec..d64e648 100644 --- a/src/coordinates/horizontal.hpp +++ b/src/coordinates/horizontal.hpp @@ -39,7 +39,7 @@ namespace rectangular { * @param lst Local sidereal time, in radians. * @return Rotation matrix. * - * @see coordinates::equatorial + * @see coordinates::rectangular::equatorial */ template math::matrix3 to_equatorial(T lat, T lst); @@ -52,7 +52,7 @@ namespace rectangular { * @param lst Local sidereal time, in radians. * @return Rectangular coordinates in equatorial space. * - * @see coordinates::equatorial + * @see coordinates::rectangular::equatorial */ template math::vector3 to_equatorial(const math::vector3& v, T lat, T lst); @@ -65,7 +65,7 @@ namespace rectangular { * @param lst Local sidereal time, in radians. * @return Rotation matrix. * - * @see coordinates::ecliptic + * @see coordinates::rectangular::ecliptic */ template math::matrix3 to_ecliptic(T ecl, T lat, T lst); @@ -79,7 +79,7 @@ namespace rectangular { * @param lst Local sidereal time, in radians. * @return Rectangular coordinates in ecliptic space. * - * @see coordinates::ecliptic + * @see coordinates::rectangular::ecliptic */ template math::vector3 to_ecliptic(const math::vector3& v, T ecl, T lat, T lst); @@ -101,7 +101,7 @@ namespace spherical { * @param lst Local sidereal time, in radians. * @return Spherical coordinates in equatorial space, in the ISO order of radial distance, declination (radians), and right ascension (radians). * - * @see coordinates::equatorial + * @see coordinates::spherical::equatorial */ template math::vector3 to_equatorial(const math::vector3& v, T lat, T lst); @@ -115,7 +115,7 @@ namespace spherical { * @param lst Local sidereal time, in radians. * @return Spherical coordinates in ecliptic space, in the ISO order of radial distance, ecliptic latitude (radians), and ecliptic longitude (radians). * - * @see coordinates::ecliptic + * @see coordinates::spherical::ecliptic */ template math::vector3 to_ecliptic(const math::vector3& v, T ecl, T lat, T lst);