Skip to content

Commit a9bb1e6

Browse files
kirawikirawi
authored
Fix Rustdoc warnings (feather-rs#409)
1 parent 47c4f82 commit a9bb1e6

22 files changed

Lines changed: 26 additions & 28 deletions

File tree

‎feather/base/src/anvil/block_entity.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ use super::player::InventorySlot;
66
/// A block entity loaded or saved to the Anvil format.
77
/// Should be serialized using NBT.
88
///
9-
/// https://minecraft.gamepedia.com/Chunk_format#Block_entity_format
9+
/// <https://minecraft.gamepedia.com/Chunk_format#Block_entity_format>
1010
#[derive(Debug, Clone, Serialize, Deserialize)]
1111
pub struct BlockEntityData {
1212
#[serde(flatten)]

‎feather/base/src/chunk/biome_store.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ impl BiomeStore {
2626
}
2727
}
2828

29-
/// Creates a `BiomeStore` from a slice of [`BIOME_PER_CHUNK`] biomes.
29+
/// Creates a `BiomeStore` from a slice of `BIOMES_PER_CHUNK` biomes.
3030
///
3131
/// Returns `None` if `biomes` is not of the correct length.
3232
pub fn from_slice(biome_slice: &[Biome]) -> Option<Self> {

‎feather/base/src/lib.rs‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ pub mod anvil;
1313
pub mod chunk;
1414
pub mod inventory;
1515
pub mod metadata;
16-
mod world;
1716

1817
pub use blocks::*;
1918
pub use chunk::{Chunk, ChunkSection, CHUNK_HEIGHT, CHUNK_WIDTH};

‎feather/base/src/metadata.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
//! This module implements the entity
2-
//! metadata format. See https://wiki.vg/Entity_metadata
2+
//! metadata format. See <https://wiki.vg/Entity_metadata>
33
//! for the specification.
44
55
use crate::{BlockPosition, Direction};

‎feather/base/src/world.rs‎

Lines changed: 0 additions & 1 deletion
This file was deleted.

‎feather/common/src/game.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ type EntitySpawnCallback = Box<dyn FnMut(&mut EntityBuilder, &EntityInit)>;
1919
/// Stores the entire state of a Minecraft game.
2020
///
2121
/// This contains:
22-
/// * A [`World`](base::World) containing chunks and blocks.
22+
/// * A [`World`](crate::World) containing chunks and blocks.
2323
/// * An [`Ecs`](ecs::Ecs) containing entities.
2424
/// * A [`Resources`](ecs::Resources) containing additional, user-defined data.
2525
/// * A [`SystemExecutor`] to run systems.

‎feather/common/src/window.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ use parking_lot::MutexGuard;
1212
/// conversion between protocol and slot indices.
1313
///
1414
/// Also provides high-level methods to interact with the inventory,
15-
/// like [`right_click`], [`shift_left_click`], etc.
15+
/// like [`Window::right_click`], [`Window::shift_click`], etc.
1616
#[derive(Debug)]
1717
pub struct Window {
1818
/// The backing window (contains the `Inventory`s)

‎feather/common/src/world.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ impl World {
5454
}
5555

5656
/// Loads any chunks that have been loaded asynchronously
57-
/// after a call to [`queue_chunk_load`].
57+
/// after a call to [`World::queue_chunk_load`].
5858
pub fn load_chunks(&mut self, ecs: &mut Ecs) {
5959
while let Some(loaded) = self.world_source.poll_loaded_chunk() {
6060
self.loading_chunks.remove(&loaded.pos);

‎feather/datapacks/src/id.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@ use std::{
77
};
88

99
/// A namespaced identifier, also known as a "resource location"
10-
/// in Forge. See https://minecraft.gamepedia.com/Namespaced_ID.
10+
/// in Forge. See <https://minecraft.gamepedia.com/Namespaced_ID>.
1111
///
1212
/// Namespaced IDs can be parsed using the `FromStr` implementation,
1313
/// and they can be formatted using the `Display` impl or by calling `to_string()`.

‎feather/ecs/src/lib.rs‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -96,7 +96,7 @@ impl Ecs {
9696

9797
/// Adds a component to an entity.
9898
///
99-
/// Do not use this function to add events. Use [`insert_event`]
99+
/// Do not use this function to add events. Use [`Ecs::insert_event`]
100100
/// instead.
101101
pub fn insert(
102102
&mut self,

0 commit comments

Comments
 (0)