chore(doc): inline re-exported API docs

This commit is contained in:
Michael Aaron Murphy 2024-05-20 17:19:42 +02:00
parent 16c1265535
commit 0d4c3db162
No known key found for this signature in database
GPG key ID: B2732D4240C9212C
5 changed files with 93 additions and 2 deletions

View file

@ -1,3 +1,5 @@
//! Integrations for cosmic-config — the cosmic configuration system.
use notify::{ use notify::{
event::{EventKind, ModifyKind}, event::{EventKind, ModifyKind},
Watcher, Watcher,

View file

@ -4,4 +4,5 @@
//! Configurations available to libcosmic applications. //! Configurations available to libcosmic applications.
pub mod toolkit; pub mod toolkit;
#[doc(inline)]
pub use toolkit::CosmicTk; pub use toolkit::CosmicTk;

View file

@ -29,7 +29,10 @@ pub mod command;
pub mod config; pub mod config;
#[doc(inline)]
pub use cosmic_config; pub use cosmic_config;
#[doc(inline)]
pub use cosmic_theme; pub use cosmic_theme;
#[cfg(any(feature = "xdg-portal", feature = "rfd"))] #[cfg(any(feature = "xdg-portal", feature = "rfd"))]
@ -43,15 +46,31 @@ mod ext;
pub mod font; pub mod font;
#[doc(inline)]
pub use iced; pub use iced;
#[doc(inline)]
pub use iced_core; pub use iced_core;
#[doc(inline)]
pub use iced_futures; pub use iced_futures;
#[doc(inline)]
pub use iced_renderer; pub use iced_renderer;
#[doc(inline)]
pub use iced_runtime; pub use iced_runtime;
#[cfg(feature = "wayland")] #[cfg(feature = "wayland")]
pub use iced_sctk; pub use iced_sctk;
#[doc(inline)]
pub use iced_style; pub use iced_style;
#[doc(inline)]
pub use iced_widget; pub use iced_widget;
#[doc(inline)]
#[cfg(feature = "winit")] #[cfg(feature = "winit")]
pub use iced_winit; pub use iced_winit;
@ -67,6 +86,8 @@ pub mod process;
pub use cctk; pub use cctk;
pub mod theme; pub mod theme;
#[doc(inline)]
pub use theme::{style, Theme}; pub use theme::{style, Theme};
pub mod widget; pub mod widget;

View file

@ -9,18 +9,27 @@ pub use self::button::Button;
mod dropdown; mod dropdown;
pub mod iced; pub mod iced;
#[doc(inline)]
pub use self::iced::Application; pub use self::iced::Application;
#[doc(inline)]
pub use self::iced::Checkbox; pub use self::iced::Checkbox;
#[doc(inline)]
pub use self::iced::Container; pub use self::iced::Container;
#[doc(inline)]
pub use self::iced::ProgressBar; pub use self::iced::ProgressBar;
#[doc(inline)]
pub use self::iced::Rule; pub use self::iced::Rule;
#[doc(inline)]
pub use self::iced::Svg; pub use self::iced::Svg;
#[doc(inline)]
pub use self::iced::Text; pub use self::iced::Text;
pub mod menu_bar; pub mod menu_bar;
mod segmented_button; mod segmented_button;
#[doc(inline)]
pub use self::segmented_button::SegmentedButton; pub use self::segmented_button::SegmentedButton;
mod text_input; mod text_input;
#[doc(inline)]
pub use self::text_input::TextInput; pub use self::text_input::TextInput;

View file

@ -4,40 +4,73 @@
//! Cosmic-themed widget implementations. //! Cosmic-themed widget implementations.
// Re-exports from Iced // Re-exports from Iced
#[doc(inline)]
pub use iced::widget::{checkbox, Checkbox}; pub use iced::widget::{checkbox, Checkbox};
#[doc(inline)]
pub use iced::widget::{combo_box, ComboBox}; pub use iced::widget::{combo_box, ComboBox};
#[doc(inline)]
pub use iced::widget::{container, Container}; pub use iced::widget::{container, Container};
#[doc(inline)]
pub use iced::widget::{horizontal_space, space, vertical_space, Space}; pub use iced::widget::{horizontal_space, space, vertical_space, Space};
#[doc(inline)]
pub use iced::widget::{image, Image}; pub use iced::widget::{image, Image};
#[doc(inline)]
pub use iced::widget::{lazy, Lazy}; pub use iced::widget::{lazy, Lazy};
#[doc(inline)]
pub use iced::widget::{mouse_area, MouseArea}; pub use iced::widget::{mouse_area, MouseArea};
#[doc(inline)]
pub use iced::widget::{pane_grid, PaneGrid}; pub use iced::widget::{pane_grid, PaneGrid};
#[doc(inline)]
pub use iced::widget::{progress_bar, ProgressBar}; pub use iced::widget::{progress_bar, ProgressBar};
#[doc(inline)]
pub use iced::widget::{radio, Radio}; pub use iced::widget::{radio, Radio};
#[doc(inline)]
pub use iced::widget::{responsive, Responsive}; pub use iced::widget::{responsive, Responsive};
#[doc(inline)]
pub use iced::widget::{slider, vertical_slider, Slider, VerticalSlider}; pub use iced::widget::{slider, vertical_slider, Slider, VerticalSlider};
#[doc(inline)]
pub use iced::widget::{svg, Svg}; pub use iced::widget::{svg, Svg};
#[doc(inline)]
pub use iced_core::widget::{Id, Operation, Widget}; pub use iced_core::widget::{Id, Operation, Widget};
pub mod aspect_ratio; pub mod aspect_ratio;
pub mod button; pub mod button;
#[doc(inline)]
pub use button::{button, Button, IconButton, LinkButton, TextButton}; pub use button::{button, Button, IconButton, LinkButton, TextButton};
pub(crate) mod common; pub(crate) mod common;
pub mod calendar; pub mod calendar;
#[doc(inline)]
pub use calendar::{calendar, Calendar}; pub use calendar::{calendar, Calendar};
pub mod card; pub mod card;
#[doc(inline)]
pub use card::*; pub use card::*;
pub mod color_picker; pub mod color_picker;
#[doc(inline)]
pub use color_picker::{ColorPicker, ColorPickerModel}; pub use color_picker::{ColorPicker, ColorPickerModel};
pub mod context_drawer; pub mod context_drawer;
#[doc(inline)]
pub use context_drawer::{context_drawer, ContextDrawer}; pub use context_drawer::{context_drawer, ContextDrawer};
#[doc(inline)]
pub use column::{column, Column}; pub use column::{column, Column};
pub mod column { pub mod column {
pub type Column<'a, Message> = iced::widget::Column<'a, Message, crate::Theme, crate::Renderer>; pub type Column<'a, Message> = iced::widget::Column<'a, Message, crate::Theme, crate::Renderer>;
@ -59,12 +92,15 @@ pub mod column {
} }
pub mod layer_container; pub mod layer_container;
#[doc(inline)]
pub use layer_container::{layer_container, LayerContainer}; pub use layer_container::{layer_container, LayerContainer};
pub mod context_menu; pub mod context_menu;
#[doc(inline)]
pub use context_menu::{context_menu, ContextMenu}; pub use context_menu::{context_menu, ContextMenu};
pub mod dialog; pub mod dialog;
#[doc(inline)]
pub use dialog::{dialog, Dialog}; pub use dialog::{dialog, Dialog};
/// An element to distinguish a boundary between two elements. /// An element to distinguish a boundary between two elements.
@ -117,46 +153,59 @@ pub mod divider {
} }
pub mod dnd_destination; pub mod dnd_destination;
#[doc(inline)]
pub use dnd_destination::{dnd_destination, DndDestination}; pub use dnd_destination::{dnd_destination, DndDestination};
pub mod dnd_source; pub mod dnd_source;
#[doc(inline)]
pub use dnd_source::{dnd_source, DndSource}; pub use dnd_source::{dnd_source, DndSource};
pub mod dropdown; pub mod dropdown;
#[doc(inline)]
pub use dropdown::{dropdown, Dropdown}; pub use dropdown::{dropdown, Dropdown};
pub mod flex_row; pub mod flex_row;
#[doc(inline)]
pub use flex_row::{flex_row, FlexRow}; pub use flex_row::{flex_row, FlexRow};
pub mod grid; pub mod grid;
#[doc(inline)]
pub use grid::{grid, Grid}; pub use grid::{grid, Grid};
mod header_bar; mod header_bar;
#[doc(inline)]
pub use header_bar::{header_bar, HeaderBar}; pub use header_bar::{header_bar, HeaderBar};
pub mod icon; pub mod icon;
#[doc(inline)]
pub use icon::{icon, Icon}; pub use icon::{icon, Icon};
#[cfg(feature = "animated-image")] #[cfg(feature = "animated-image")]
pub mod frames; pub mod frames;
pub mod list; pub mod list;
pub use list::*; #[doc(inline)]
pub use list::{list_column, ListColumn};
pub mod menu; pub mod menu;
pub mod nav_bar; pub mod nav_bar;
#[doc(inline)]
pub use nav_bar::{nav_bar, nav_bar_dnd}; pub use nav_bar::{nav_bar, nav_bar_dnd};
pub mod nav_bar_toggle; pub mod nav_bar_toggle;
#[doc(inline)]
pub use nav_bar_toggle::{nav_bar_toggle, NavBarToggle}; pub use nav_bar_toggle::{nav_bar_toggle, NavBarToggle};
pub mod popover; pub mod popover;
#[doc(inline)]
pub use popover::{popover, Popover}; pub use popover::{popover, Popover};
pub mod rectangle_tracker; pub mod rectangle_tracker;
#[doc(inline)]
pub use rectangle_tracker::{rectangle_tracker, RectangleTracker}; pub use rectangle_tracker::{rectangle_tracker, RectangleTracker};
#[doc(inline)]
pub use row::{row, Row}; pub use row::{row, Row};
pub mod row { pub mod row {
pub type Row<'a, Message> = iced::widget::Row<'a, Message, crate::Theme, crate::Renderer>; pub type Row<'a, Message> = iced::widget::Row<'a, Message, crate::Theme, crate::Renderer>;
@ -178,6 +227,7 @@ pub mod row {
} }
mod scrollable; mod scrollable;
#[doc(inline)]
pub use scrollable::*; pub use scrollable::*;
pub mod segmented_button; pub mod segmented_button;
@ -186,19 +236,26 @@ pub mod segmented_control;
pub mod settings; pub mod settings;
pub mod spin_button; pub mod spin_button;
#[doc(inline)]
pub use spin_button::{spin_button, SpinButton}; pub use spin_button::{spin_button, SpinButton};
pub mod tab_bar; pub mod tab_bar;
pub mod text; pub mod text;
#[doc(inline)]
pub use text::{text, Text}; pub use text::{text, Text};
pub mod text_input; pub mod text_input;
pub use text_input::*; #[doc(inline)]
pub use text_input::{
editable_input, inline_input, search_input, secure_input, text_input, TextInput,
};
mod toggler; mod toggler;
#[doc(inline)]
pub use toggler::toggler; pub use toggler::toggler;
#[doc(inline)]
pub use tooltip::{tooltip, Tooltip}; pub use tooltip::{tooltip, Tooltip};
pub mod tooltip { pub mod tooltip {
use crate::Element; use crate::Element;
@ -224,4 +281,5 @@ pub mod tooltip {
} }
pub mod warning; pub mod warning;
#[doc(inline)]
pub use warning::*; pub use warning::*;