Merge pull request #1068 from CesiumGS/geospatial-guide-tag

Link to Geospatial Guide instead of including a glossary

Author: kring

CesiumGeospatial/include/CesiumGeospatial/Ellipsoid.h

@@ -33,6 +33,8 @@ namespace CesiumGeospatial {
  * 1`. This is primarily used by Cesium to represent the shape of planetary
  * bodies. Rather than constructing this object directly, one of the provided
  * constants is normally used.
+ *
+ * @see \ref what-is-an-ellipsoid
  */
 class CESIUMGEOSPATIAL_API Ellipsoid final {
 public:

CesiumGeospatial/include/CesiumGeospatial/GlobeAnchor.h

@@ -14,7 +14,7 @@ class LocalHorizontalCoordinateSystem;
 /**
  * @brief Anchors an object to the globe by defining a transformation from the
  * object's coordinate to the globe-fixed coordinate system (usually
- * \ref glossary-ecef).
+ * \ref what-are-ecef-coordinates).
  *
  * This class allows the anchored coordinate system to be realized in any
  * {@link LocalHorizontalCoordinateSystem}. When the object is moved, either by

CesiumGeospatial/include/CesiumGeospatial/LocalHorizontalCoordinateSystem.h

@@ -55,8 +55,8 @@ class CESIUMGEOSPATIAL_API LocalHorizontalCoordinateSystem {
       const Ellipsoid& ellipsoid = CesiumGeospatial::Ellipsoid::WGS84);
 
   /**
-   * @brief Create a new coordinate system centered at a \ref glossary-ecef
-   * "Earth-Centered, Earth-Fixed" position.
+   * @brief Create a new coordinate system centered at a \ref
+   * what-are-ecef-coordinates "Earth-Centered, Earth-Fixed" position.
    *
    * @param originEcef The origin of the coordinate system.
    * @param xAxisDirection The local direction in which the X axis points at the
@@ -80,8 +80,8 @@ class CESIUMGEOSPATIAL_API LocalHorizontalCoordinateSystem {
 
   /**
    * @brief Create a new coordinate system with a specified transformation to
-   * the \ref glossary-ecef "Earth-Centered, Earth-Fixed" frame. This is an
-   * advanced constructor and should be avoided in most cases.
+   * the \ref what-are-ecef-coordinates "Earth-Centered, Earth-Fixed" frame.
+   * This is an advanced constructor and should be avoided in most cases.
    *
    * This constructor can be used to save/restore the state of an instance. It
    * can also be used to create unusual coordinate systems that can't be created
@@ -96,8 +96,8 @@ class CESIUMGEOSPATIAL_API LocalHorizontalCoordinateSystem {
   /**
    * @brief Create a new coordinate system with the specified transformations
    * between the local frame and the
-   * \ref glossary-ecef "Earth-Centered, Earth-Fixed" frame. This is an advanced
-   * constructor and should be avoided in most cases.
+   * \ref what-are-ecef-coordinates "Earth-Centered, Earth-Fixed" frame. This is
+   * an advanced constructor and should be avoided in most cases.
    *
    * This constructor can be used to save/restore the state of an instance. It
    * can also be used to create unusual coordinate systems that can't be created
@@ -117,7 +117,7 @@ class CESIUMGEOSPATIAL_API LocalHorizontalCoordinateSystem {
 
   /**
    * @brief Gets the transformation matrix from the local horizontal coordinate
-   * system managed by this instance to the \ref glossary-ecef.
+   * system managed by this instance to the \ref what-are-ecef-coordinates.
    *
    * @return The transformation.
    */
@@ -126,8 +126,8 @@ class CESIUMGEOSPATIAL_API LocalHorizontalCoordinateSystem {
   }
 
   /**
-   * @brief Gets the transformation matrix from \ref glossary-ecef to the
-   * local horizontal coordinate system managed by this instance.
+   * @brief Gets the transformation matrix from \ref what-are-ecef-coordinates
+   * to the local horizontal coordinate system managed by this instance.
    *
    * @return The transformation.
    */
@@ -138,7 +138,7 @@ class CESIUMGEOSPATIAL_API LocalHorizontalCoordinateSystem {
   /**
    * @brief Converts a position in the local horizontal coordinate system
    * managed by this instance to
-   * \ref glossary-ecef "Earth-Centered, Earth-Fixed (ECEF)".
+   * \ref what-are-ecef-coordinates "Earth-Centered, Earth-Fixed (ECEF)".
    *
    * @param localPosition The position in the local coordinate system.
    * @return The equivalent position in the ECEF coordinate system.
@@ -148,8 +148,9 @@ class CESIUMGEOSPATIAL_API LocalHorizontalCoordinateSystem {
 
   /**
    * @brief Converts a position in the
-   * \ref glossary-ecef "Earth-Centered, Earth-Fixed (ECEF)" coordinate system
-   * to the local horizontal coordinate system managed by this instance.
+   * \ref what-are-ecef-coordinates "Earth-Centered, Earth-Fixed (ECEF)"
+   * coordinate system to the local horizontal coordinate system managed by this
+   * instance.
    *
    * @param ecefPosition The position in the ECEF coordinate system.
    * @return The equivalent position in the local coordinate system.
@@ -159,7 +160,7 @@ class CESIUMGEOSPATIAL_API LocalHorizontalCoordinateSystem {
   /**
    * @brief Converts a direction in the local horizontal coordinate system
    * managed by this instance to
-   * \ref glossary-ecef "Earth-Centered, Earth-Fixed (ECEF)".
+   * \ref what-are-ecef-coordinates "Earth-Centered, Earth-Fixed (ECEF)".
    *
    * Because the vector is treated as a direction only, the translation portion
    * of the transformation is ignored.
@@ -172,8 +173,9 @@ class CESIUMGEOSPATIAL_API LocalHorizontalCoordinateSystem {
 
   /**
    * @brief Converts a direction in the
-   * \ref glossary-ecef "Earth-Centered, Earth-Fixed (ECEF)" coordinate system
-   * to the local horizontal coordinate system managed by this instance.
+   * \ref what-are-ecef-coordinates "Earth-Centered, Earth-Fixed (ECEF)"
+   * coordinate system to the local horizontal coordinate system managed by this
+   * instance.
    *
    * Because the vector is treated as a direction only, the translation portion
    * of the transformation is ignored.

CesiumGltfContent/include/CesiumGltfContent/SkirtMeshMetadata.h

@@ -89,7 +89,8 @@ struct SkirtMeshMetadata {
    */
   uint32_t noSkirtVerticesCount;
   /**
-   * @brief The center coordinates of the mesh, in \ref glossary-ecef.
+   * @brief The center coordinates of the mesh, in \ref
+   * what-are-ecef-coordinates.
    */
   glm::dvec3 meshCenter;
   /**

doc/CMakeLists.txt

@@ -115,6 +115,8 @@ if(DOXYGEN_FOUND)
     set(DOXYGEN_VERBATIM_VARS DOXYGEN_ALIASES DOXYGEN_HTML_EXTRA_FILES)
     list(APPEND DOXYGEN_EXAMPLE_PATH "${CMAKE_CURRENT_LIST_DIR}/diagrams")
 
+    list(APPEND DOXYGEN_TAGFILES "${CMAKE_CURRENT_LIST_DIR}/community.tag=https://github.com/CesiumGS/community/blob/main")
+
     cesium_glob_files(
       CESIUM_DOC_TOPICS
       ${CMAKE_CURRENT_LIST_DIR}/topics/*.md

doc/community.tag

@@ -0,0 +1,14 @@
+<?xml version='1.0' encoding='UTF-8' standalone='yes' ?>
+<!-- 
+  This is a handcrafted tag file for the CesiumGS/community repo. 
+  Pages and headings should be added to this file as needed.
+  -->
+<tagfile doxygen_version="1.12.0" doxygen_gitid="c73f5d30f9e8b1df5ba15a1d064ff2067cbb8267">
+    <compound kind="page">
+        <name>geospatial-guide</name>
+        <title>Geospatial Guide</title>
+        <filename>GeospatialGuide/README.md</filename>
+        <docanchor file="GeospatialGuide/README.md" title="Earth-Centered, Earth-Fixed Coordinates (ECEF)">what-are-ecef-coordinates</docanchor>
+        <docanchor file="GeospatialGuide/README.md" title="What is an ellipsoid?">what-is-an-ellipsoid</docanchor>
+    </compound>
+</tagfile>

doc/topics/developer.md

@@ -5,9 +5,10 @@
 * \subpage developer-setup
 * \subpage style-guide
 * \subpage contributing
+* \subpage geospatial-guide
 
 ## Architecture of Cesium Native
 
 * \subpage multithreading
 * \subpage selection-algorithm-details
-* \subpage rendering-3d-tiles
+* \subpage rendering-3d-tiles