Browse Source

Fix broken namespace links in coordinate systems documentation

master
C. J. Howard 3 years ago
parent
commit
97a0275899
3 changed files with 18 additions and 24 deletions
  1. +6
    -12
      src/coordinates/ecliptic.hpp
  2. +6
    -6
      src/coordinates/equatorial.hpp
  3. +6
    -6
      src/coordinates/horizontal.hpp

+ 6
- 12
src/coordinates/ecliptic.hpp View File

@ -38,7 +38,7 @@ namespace rectangular {
* @param ecl Obliquity of the ecliptic, in radians. * @param ecl Obliquity of the ecliptic, in radians.
* @return Rotation matrix. * @return Rotation matrix.
* *
* @see coordinates::equatorial
* @see coordinates::rectangular::equatorial
*/ */
template <class T> template <class T>
math::matrix3<T> to_equatorial(T ecl); math::matrix3<T> to_equatorial(T ecl);
@ -50,10 +50,7 @@ namespace rectangular {
* @param ecl Obliquity of the ecliptic, in radians. * @param ecl Obliquity of the ecliptic, in radians.
* @return Rectangular coordinates in equatorial space. * @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 <class T> template <class T>
math::vector3<T> to_equatorial(const math::vector3<T>& v, T ecl); math::vector3<T> to_equatorial(const math::vector3<T>& v, T ecl);
@ -66,7 +63,7 @@ namespace rectangular {
* @param lst Local sidereal time, in radians. * @param lst Local sidereal time, in radians.
* @return Rotation matrix. * @return Rotation matrix.
* *
* @see coordinates::horizontal
* @see coordinates::rectangular::horizontal
*/ */
template <class T> template <class T>
math::matrix3<T> to_horizontal(T ecl, T lat, T lst); math::matrix3<T> to_horizontal(T ecl, T lat, T lst);
@ -80,10 +77,7 @@ namespace rectangular {
* @param lst Local sidereal time, in radians. * @param lst Local sidereal time, in radians.
* @return Rectangular coordinates in local horizontal space. * @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 <class T> template <class T>
math::vector3<T> to_horizontal(const math::vector3<T>& v, T ecl, T lat, T lst); math::vector3<T> to_horizontal(const math::vector3<T>& v, T ecl, T lat, T lst);
@ -104,7 +98,7 @@ namespace spherical {
* @param ecl Obliquity of the ecliptic, in radians. * @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). * @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 <class T> template <class T>
math::vector3<T> to_equatorial(const math::vector3<T>& v, T ecl); math::vector3<T> to_equatorial(const math::vector3<T>& v, T ecl);
@ -118,7 +112,7 @@ namespace spherical {
* @param lst Local sidereal time, in radians. * @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). * @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 <class T> template <class T>
math::vector3<T> to_horizontal(const math::vector3<T>& v, T ecl, T lat, T lst); math::vector3<T> to_horizontal(const math::vector3<T>& v, T ecl, T lat, T lst);

+ 6
- 6
src/coordinates/equatorial.hpp View File

@ -38,7 +38,7 @@ namespace rectangular {
* @param ecl Obliquity of the ecliptic, in radians. * @param ecl Obliquity of the ecliptic, in radians.
* @return Rotation matrix. * @return Rotation matrix.
* *
* @see coordinates::ecliptic
* @see coordinates::rectangular::ecliptic
*/ */
template <class T> template <class T>
math::matrix3<T> to_ecliptic(T ecl); math::matrix3<T> to_ecliptic(T ecl);
@ -50,7 +50,7 @@ namespace rectangular {
* @param ecl Obliquity of the ecliptic, in radians. * @param ecl Obliquity of the ecliptic, in radians.
* @return Rectangular coordinates in ecliptic space. * @return Rectangular coordinates in ecliptic space.
* *
* @see coordinates::ecliptic
* @see coordinates::rectangular::ecliptic
*/ */
template <class T> template <class T>
math::vector3<T> to_ecliptic(const math::vector3<T>& v, T ecl); math::vector3<T> to_ecliptic(const math::vector3<T>& v, T ecl);
@ -62,7 +62,7 @@ namespace rectangular {
* @param lst Local sidereal time, in radians. * @param lst Local sidereal time, in radians.
* @return Rotation matrix. * @return Rotation matrix.
* *
* @see coordinates::horizontal
* @see coordinates::rectangular::horizontal
*/ */
template <class T> template <class T>
math::matrix3<T> to_horizontal(T lat, T lst); math::matrix3<T> to_horizontal(T lat, T lst);
@ -75,7 +75,7 @@ namespace rectangular {
* @param lst Local sidereal time, in radians. * @param lst Local sidereal time, in radians.
* @return Rectangular coordinates in local horizontal space. * @return Rectangular coordinates in local horizontal space.
* *
* @see coordinates::horizontal
* @see coordinates::rectangular::horizontal
*/ */
template <class T> template <class T>
math::vector3<T> to_horizontal(const math::vector3<T>& v, T lat, T lst); math::vector3<T> to_horizontal(const math::vector3<T>& v, T lat, T lst);
@ -96,7 +96,7 @@ namespace spherical {
* @param ecl Obliquity of the ecliptic, in radians. * @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). * @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 <class T> template <class T>
math::vector3<T> to_ecliptic(const math::vector3<T>& v, T ecl); math::vector3<T> to_ecliptic(const math::vector3<T>& v, T ecl);
@ -109,7 +109,7 @@ namespace spherical {
* @param lst Local sidereal time, in radians. * @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). * @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 <class T> template <class T>
math::vector3<T> to_horizontal(const math::vector3<T>& v, T lat, T lst); math::vector3<T> to_horizontal(const math::vector3<T>& v, T lat, T lst);

+ 6
- 6
src/coordinates/horizontal.hpp View File

@ -39,7 +39,7 @@ namespace rectangular {
* @param lst Local sidereal time, in radians. * @param lst Local sidereal time, in radians.
* @return Rotation matrix. * @return Rotation matrix.
* *
* @see coordinates::equatorial
* @see coordinates::rectangular::equatorial
*/ */
template <class T> template <class T>
math::matrix3<T> to_equatorial(T lat, T lst); math::matrix3<T> to_equatorial(T lat, T lst);
@ -52,7 +52,7 @@ namespace rectangular {
* @param lst Local sidereal time, in radians. * @param lst Local sidereal time, in radians.
* @return Rectangular coordinates in equatorial space. * @return Rectangular coordinates in equatorial space.
* *
* @see coordinates::equatorial
* @see coordinates::rectangular::equatorial
*/ */
template <class T> template <class T>
math::vector3<T> to_equatorial(const math::vector3<T>& v, T lat, T lst); math::vector3<T> to_equatorial(const math::vector3<T>& v, T lat, T lst);
@ -65,7 +65,7 @@ namespace rectangular {
* @param lst Local sidereal time, in radians. * @param lst Local sidereal time, in radians.
* @return Rotation matrix. * @return Rotation matrix.
* *
* @see coordinates::ecliptic
* @see coordinates::rectangular::ecliptic
*/ */
template <class T> template <class T>
math::matrix3<T> to_ecliptic(T ecl, T lat, T lst); math::matrix3<T> to_ecliptic(T ecl, T lat, T lst);
@ -79,7 +79,7 @@ namespace rectangular {
* @param lst Local sidereal time, in radians. * @param lst Local sidereal time, in radians.
* @return Rectangular coordinates in ecliptic space. * @return Rectangular coordinates in ecliptic space.
* *
* @see coordinates::ecliptic
* @see coordinates::rectangular::ecliptic
*/ */
template <class T> template <class T>
math::vector3<T> to_ecliptic(const math::vector3<T>& v, T ecl, T lat, T lst); math::vector3<T> to_ecliptic(const math::vector3<T>& v, T ecl, T lat, T lst);
@ -101,7 +101,7 @@ namespace spherical {
* @param lst Local sidereal time, in radians. * @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). * @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 <class T> template <class T>
math::vector3<T> to_equatorial(const math::vector3<T>& v, T lat, T lst); math::vector3<T> to_equatorial(const math::vector3<T>& v, T lat, T lst);
@ -115,7 +115,7 @@ namespace spherical {
* @param lst Local sidereal time, in radians. * @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). * @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 <class T> template <class T>
math::vector3<T> to_ecliptic(const math::vector3<T>& v, T ecl, T lat, T lst); math::vector3<T> to_ecliptic(const math::vector3<T>& v, T ecl, T lat, T lst);

Loading…
Cancel
Save