Hide re-exported docs (#1985)

Solves #1957 

Co-authored-by: caelumLaron <caelum.laron@gmail.com>
This commit is contained in:
Lucas Rocha 2021-04-27 18:29:33 +00:00
parent cc0ee536f0
commit b1ed28e17e
19 changed files with 29 additions and 0 deletions

View file

@ -16,6 +16,7 @@ pub use plugin_group::*;
pub use schedule_runner::*; pub use schedule_runner::*;
pub mod prelude { pub mod prelude {
#[doc(hidden)]
pub use crate::{ pub use crate::{
app::App, app_builder::AppBuilder, CoreStage, DynamicPlugin, Plugin, PluginGroup, app::App, app_builder::AppBuilder, CoreStage, DynamicPlugin, Plugin, PluginGroup,
StartupStage, StartupStage,

View file

@ -13,6 +13,7 @@ mod loader;
mod path; mod path;
pub mod prelude { pub mod prelude {
#[doc(hidden)]
pub use crate::{AddAsset, AssetEvent, AssetServer, Assets, Handle, HandleUntyped}; pub use crate::{AddAsset, AssetEvent, AssetServer, Assets, Handle, HandleUntyped};
} }

View file

@ -3,6 +3,7 @@ mod audio_output;
mod audio_source; mod audio_source;
pub mod prelude { pub mod prelude {
#[doc(hidden)]
pub use crate::{Audio, AudioOutput, AudioSource, Decodable}; pub use crate::{Audio, AudioOutput, AudioSource, Decodable};
} }

View file

@ -13,6 +13,7 @@ pub use task_pool_options::DefaultTaskPoolOptions;
pub use time::*; pub use time::*;
pub mod prelude { pub mod prelude {
#[doc(hidden)]
pub use crate::{DefaultTaskPoolOptions, EntityLabels, Labels, Name, Time, Timer}; pub use crate::{DefaultTaskPoolOptions, EntityLabels, Labels, Name, Time, Timer};
} }

View file

@ -12,8 +12,10 @@ pub mod system;
pub mod world; pub mod world;
pub mod prelude { pub mod prelude {
#[doc(hidden)]
#[cfg(feature = "bevy_reflect")] #[cfg(feature = "bevy_reflect")]
pub use crate::reflect::ReflectComponent; pub use crate::reflect::ReflectComponent;
#[doc(hidden)]
pub use crate::{ pub use crate::{
bundle::Bundle, bundle::Bundle,
entity::Entity, entity::Entity,

View file

@ -14,6 +14,7 @@ use bevy_ecs::{
pub use input::*; pub use input::*;
pub mod prelude { pub mod prelude {
#[doc(hidden)]
pub use crate::{ pub use crate::{
gamepad::{ gamepad::{
Gamepad, GamepadAxis, GamepadAxisType, GamepadButton, GamepadButtonType, GamepadEvent, Gamepad, GamepadAxis, GamepadAxisType, GamepadButton, GamepadButtonType, GamepadEvent,

View file

@ -1,3 +1,4 @@
#[doc(hidden)]
pub use crate::{ pub use crate::{
app::prelude::*, asset::prelude::*, core::prelude::*, ecs::prelude::*, input::prelude::*, app::prelude::*, asset::prelude::*, core::prelude::*, ecs::prelude::*, input::prelude::*,
log::prelude::*, math::prelude::*, reflect::prelude::*, scene::prelude::*, log::prelude::*, math::prelude::*, reflect::prelude::*, scene::prelude::*,
@ -6,26 +7,34 @@ pub use crate::{
pub use bevy_derive::bevy_main; pub use bevy_derive::bevy_main;
#[doc(hidden)]
#[cfg(feature = "bevy_audio")] #[cfg(feature = "bevy_audio")]
pub use crate::audio::prelude::*; pub use crate::audio::prelude::*;
#[doc(hidden)]
#[cfg(feature = "bevy_pbr")] #[cfg(feature = "bevy_pbr")]
pub use crate::pbr::prelude::*; pub use crate::pbr::prelude::*;
#[doc(hidden)]
#[cfg(feature = "bevy_render")] #[cfg(feature = "bevy_render")]
pub use crate::render::prelude::*; pub use crate::render::prelude::*;
#[doc(hidden)]
#[cfg(feature = "bevy_sprite")] #[cfg(feature = "bevy_sprite")]
pub use crate::sprite::prelude::*; pub use crate::sprite::prelude::*;
#[doc(hidden)]
#[cfg(feature = "bevy_text")] #[cfg(feature = "bevy_text")]
pub use crate::text::prelude::*; pub use crate::text::prelude::*;
#[doc(hidden)]
#[cfg(feature = "bevy_ui")] #[cfg(feature = "bevy_ui")]
pub use crate::ui::prelude::*; pub use crate::ui::prelude::*;
#[doc(hidden)]
#[cfg(feature = "bevy_dynamic_plugin")] #[cfg(feature = "bevy_dynamic_plugin")]
pub use crate::dynamic_plugin::*; pub use crate::dynamic_plugin::*;
#[doc(hidden)]
#[cfg(feature = "bevy_gilrs")] #[cfg(feature = "bevy_gilrs")]
pub use crate::gilrs::*; pub use crate::gilrs::*;

View file

@ -2,6 +2,7 @@
mod android_tracing; mod android_tracing;
pub mod prelude { pub mod prelude {
#[doc(hidden)]
pub use bevy_utils::tracing::{ pub use bevy_utils::tracing::{
debug, debug_span, error, error_span, info, info_span, trace, trace_span, warn, warn_span, debug, debug_span, error, error_span, info, info_span, trace, trace_span, warn, warn_span,
}; };

View file

@ -6,6 +6,7 @@ pub use geometry::*;
pub use glam::*; pub use glam::*;
pub mod prelude { pub mod prelude {
#[doc(hidden)]
pub use crate::{ pub use crate::{
BVec2, BVec3, BVec4, FaceToward, IVec2, IVec3, IVec4, Mat3, Mat4, Quat, Rect, Size, UVec2, BVec2, BVec3, BVec4, FaceToward, IVec2, IVec3, IVec4, Mat3, Mat4, Quat, Rect, Size, UVec2,
UVec3, UVec4, Vec2, Vec3, Vec4, UVec3, UVec4, Vec2, Vec3, Vec4,

View file

@ -9,6 +9,7 @@ pub use light::*;
pub use material::*; pub use material::*;
pub mod prelude { pub mod prelude {
#[doc(hidden)]
pub use crate::{entity::*, light::PointLight, material::StandardMaterial}; pub use crate::{entity::*, light::PointLight, material::StandardMaterial};
} }

View file

@ -23,6 +23,7 @@ mod impls {
pub mod serde; pub mod serde;
pub mod prelude { pub mod prelude {
#[doc(hidden)]
pub use crate::{ pub use crate::{
reflect_trait, GetField, GetTupleStructField, Reflect, ReflectDeserialize, Struct, reflect_trait, GetField, GetTupleStructField, Reflect, ReflectDeserialize, Struct,
TupleStruct, TupleStruct,

View file

@ -23,6 +23,7 @@ use draw::{OutsideFrustum, Visible};
pub use once_cell; pub use once_cell;
pub mod prelude { pub mod prelude {
#[doc(hidden)]
pub use crate::{ pub use crate::{
base::Msaa, base::Msaa,
color::Color, color::Color,

View file

@ -12,6 +12,7 @@ pub use scene_loader::*;
pub use scene_spawner::*; pub use scene_spawner::*;
pub mod prelude { pub mod prelude {
#[doc(hidden)]
pub use crate::{ pub use crate::{
DynamicScene, Scene, SceneSpawner, SpawnSceneAsChildCommands, SpawnSceneCommands, DynamicScene, Scene, SceneSpawner, SpawnSceneAsChildCommands, SpawnSceneCommands,
}; };

View file

@ -11,6 +11,7 @@ mod texture_atlas;
mod texture_atlas_builder; mod texture_atlas_builder;
pub mod prelude { pub mod prelude {
#[doc(hidden)]
pub use crate::{ pub use crate::{
entity::{SpriteBundle, SpriteSheetBundle}, entity::{SpriteBundle, SpriteSheetBundle},
ColorMaterial, Sprite, SpriteResizeMode, TextureAtlas, TextureAtlasSprite, ColorMaterial, Sprite, SpriteResizeMode, TextureAtlas, TextureAtlasSprite,

View file

@ -24,6 +24,7 @@ mod iter;
pub use iter::ParallelIterator; pub use iter::ParallelIterator;
pub mod prelude { pub mod prelude {
#[doc(hidden)]
pub use crate::{ pub use crate::{
iter::ParallelIterator, iter::ParallelIterator,
slice::{ParallelSlice, ParallelSliceMut}, slice::{ParallelSlice, ParallelSliceMut},

View file

@ -21,7 +21,9 @@ pub use text::*;
pub use text2d::*; pub use text2d::*;
pub mod prelude { pub mod prelude {
#[doc(hidden)]
pub use crate::{Font, Text, Text2dBundle, TextAlignment, TextError, TextSection, TextStyle}; pub use crate::{Font, Text, Text2dBundle, TextAlignment, TextError, TextSection, TextStyle};
#[doc(hidden)]
pub use glyph_brush_layout::{HorizontalAlign, VerticalAlign}; pub use glyph_brush_layout::{HorizontalAlign, VerticalAlign};
} }

View file

@ -3,6 +3,7 @@ pub mod hierarchy;
pub mod transform_propagate_system; pub mod transform_propagate_system;
pub mod prelude { pub mod prelude {
#[doc(hidden)]
pub use crate::{components::*, hierarchy::*, TransformPlugin}; pub use crate::{components::*, hierarchy::*, TransformPlugin};
} }

View file

@ -17,6 +17,7 @@ pub use render::*;
pub use ui_node::*; pub use ui_node::*;
pub mod prelude { pub mod prelude {
#[doc(hidden)]
pub use crate::{entity::*, ui_node::*, widget::Button, Anchors, Interaction, Margins}; pub use crate::{entity::*, ui_node::*, widget::Button, Anchors, Interaction, Margins};
} }

View file

@ -10,6 +10,7 @@ pub use window::*;
pub use windows::*; pub use windows::*;
pub mod prelude { pub mod prelude {
#[doc(hidden)]
pub use crate::{ pub use crate::{
CursorEntered, CursorLeft, CursorMoved, FileDragAndDrop, ReceivedCharacter, Window, CursorEntered, CursorLeft, CursorMoved, FileDragAndDrop, ReceivedCharacter, Window,
WindowDescriptor, WindowMoved, Windows, WindowDescriptor, WindowMoved, Windows,