fixed some broken links in docs

JeroenGar · Nov 12, 2024 · d0d8caf · d0d8caf
1 parent b096755
commit d0d8caf
Show file tree

Hide file tree

Showing 4 changed files with 7 additions and 7 deletions.
diff --git a/.github/workflows/doc.yml b/.github/workflows/doc.yml
@@ -22,10 +22,10 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - name: Build and deploy Jagua-rs docs
+      - name: Build and deploy jagua-rs docs
         run: |
           cd lbf
-          cargo doc --all
+          RUSTDOCFLAGS="-D warnings" cargo doc --all
       - name: Deploy docs
         uses: JamesIves/github-pages-deploy-action@v4
         with:

diff --git a/.github/workflows/rust.yml b/.github/workflows/rust.yml
@@ -34,12 +34,12 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       - uses: actions/checkout@v4
-      - name: Build Jagua-rs (f32)
+      - name: Build jagua-rs (f32)
         run: |
           cd jagua-rs
           cargo build --all-targets
           cargo doc
-      - name: Build Jagua-rs (f64)
+      - name: Build jagua-rs (f64)
         run: |
           cd jagua-rs
           cargo build --all-targets --features double-precision

diff --git a/jagua-rs/src/collision_detection/quadtree/qt_hazard.rs b/jagua-rs/src/collision_detection/quadtree/qt_hazard.rs
@@ -12,15 +12,15 @@ use crate::geometry::primitives::aa_rectangle::AARectangle;
 use crate::geometry::primitives::simple_polygon::SimplePolygon;
 use crate::util::assertions;
 
-/// Represents the manifestation of a [Hazard] in a [QTNode]
+/// Represents the manifestation of a [Hazard] in a [QTNode](crate::collision_detection::quadtree::qt_node::QTNode)
 #[derive(Clone, Debug)]
 pub struct QTHazard {
     pub entity: HazardEntity,
     pub presence: QTHazPresence,
     pub active: bool,
 }
 
-/// How a [Hazard] is present in a [QTNode]
+/// How a [Hazard] is present in a [QTNode](crate::collision_detection::quadtree::qt_node::QTNode)
 #[derive(Clone, Debug)]
 pub enum QTHazPresence {
     /// The hazard is entirely absent from the node

diff --git a/jagua-rs/src/collision_detection/quadtree/qt_partial_hazard.rs b/jagua-rs/src/collision_detection/quadtree/qt_partial_hazard.rs
@@ -7,7 +7,7 @@ use crate::collision_detection::quadtree::qt_traits::QTQueryable;
 use crate::geometry::geo_traits::{CollidesWith, Shape};
 use crate::geometry::primitives::simple_polygon::SimplePolygon;
 
-/// Defines a set of edges from a hazard that is partially active in the [QTNode].
+/// Defines a set of edges from a hazard that is partially active in the [QTNode](crate::collision_detection::quadtree::qt_node::QTNode).
 #[derive(Clone, Debug)]
 pub struct PartialQTHaz {
     pub shape: Weak<SimplePolygon>,