chore: improve documentation

src/app/command.rs

@@ -1,22 +1,11 @@
 // Copyright 2023 System76 <info@system76.com>
 // SPDX-License-Identifier: MPL-2.0
 
-use std::future::Future;
+/// Asynchronous actions for COSMIC applications.
+use super::Message;
 
-use super::{Command, Message};
+/// Commands for COSMIC applications.
-use iced_runtime::command::Action;
+pub type Command<M> = iced::Command<Message<M>>;
-
-/// Yields a command which contains a batch of commands.
-pub fn batch<M: Send + 'static>(commands: impl IntoIterator<Item = Command<M>>) -> Command<M> {
-    Command::batch(commands)
-}
-
-/// Yields a command which will run the future on the runtime executor.
-pub fn future<M: Send + 'static>(
-    future: impl Future<Output = Message<M>> + Send + 'static,
-) -> Command<M> {
-    Command::single(Action::Future(Box::pin(future)))
-}
 
 /// Creates a command which yields a [`crate::app::Message`].
 pub fn message<M: Send + 'static>(message: Message<M>) -> Command<M> {

src/app/mod.rs

@@ -1,6 +1,11 @@
 // Copyright 2023 System76 <info@system76.com>
 // SPDX-License-Identifier: MPL-2.0
 
+//! Build interactive cross-platform COSMIC applications.
+//!
+//! Check out our [application](https://github.com/pop-os/libcosmic/tree/master/examples/application)
+//! example in our repository.
+
 pub mod command;
 mod core;
 pub mod cosmic;
@@ -9,7 +14,7 @@ pub mod settings;
 pub mod message {
     #[derive(Clone, Debug)]
     #[must_use]
-    pub enum Message<M: Send + 'static> {
+    pub enum Message<M> {
         /// Messages from the application, for the application.
         App(M),
         /// Internal messages to be handled by libcosmic.
@@ -18,19 +23,20 @@ pub mod message {
         None,
     }
 
-    pub fn app<M: Send + 'static>(message: M) -> Message<M> {
+    pub const fn app<M>(message: M) -> Message<M> {
         Message::App(message)
     }
 
-    pub fn cosmic<M: Send + 'static>(message: super::cosmic::Message) -> Message<M> {
+    pub const fn cosmic<M>(message: super::cosmic::Message) -> Message<M> {
         Message::Cosmic(message)
     }
 
-    pub fn none<M: Send + 'static>() -> Message<M> {
+    pub const fn none<M>() -> Message<M> {
         Message::None
     }
 }
 
+pub use self::command::Command;
 pub use self::core::Core;
 pub use self::settings::Settings;
 use crate::theme::THEME;
@@ -41,10 +47,7 @@ use iced::Subscription;
 use iced::{window, Application as IcedApplication};
 pub use message::Message;
 
-/// Commands for COSMIC applications.
+/// Launch a COSMIC application with the given [`Settings`].
-pub type Command<M> = iced::Command<Message<M>>;
-
-/// Launch the application with the given settings.
 ///
 /// # Errors
 ///
@@ -102,6 +105,7 @@ pub fn run<App: Application>(settings: Settings, flags: App::Flags) -> iced::Res
     cosmic::Cosmic::<App>::run(iced)
 }
 
+/// An interactive cross-platform COSMIC application.
 #[allow(unused_variables)]
 pub trait Application
 where
@@ -245,6 +249,7 @@ impl<App: Application> ApplicationExt for App {
         iced::Command::none()
     }
 
+    /// Creates the view for the main window.
     fn view_main<'a>(&'a self) -> Element<'a, Message<Self::Message>> {
         let core = self.core();
         let is_condensed = core.is_condensed();
@@ -313,7 +318,7 @@ impl<App: Application> ApplicationExt for App {
                     }
                 }
 
-                if core.show_content() {
+                if self.nav_model().is_none() || core.show_content() {
                     let main_content = self.view().debug(core.debug).map(Message::App);
 
                     widgets.push(main_content);

src/app/settings.rs

@@ -1,11 +1,14 @@
 // Copyright 2023 System76 <info@system76.com>
 // SPDX-License-Identifier: MPL-2.0
 
+//! Configure a new COSMIC application.
+
 use crate::{font, Theme};
 #[cfg(feature = "wayland")]
 use iced::Limits;
 use iced_core::Font;
 
+/// Configure a new COSMIC application.
 #[allow(clippy::struct_excessive_bools)]
 #[derive(derive_setters::Setters)]
 pub struct Settings {

src/executor/mod.rs

@@ -1,14 +1,18 @@
 // Copyright 2023 System76 <info@system76.com>
 // SPDX-License-Identifier: MPL-2.0
 
+//! Select the preferred async executor for an application.
+
 #[cfg(feature = "tokio")]
 pub mod multi;
 
 #[cfg(feature = "tokio")]
 pub mod single;
 
+/// Uses the single thread executor by default.
 #[cfg(not(feature = "tokio"))]
 pub type Default = iced::executor::Default;
 
+/// Uses the single thread executor by default.
 #[cfg(feature = "tokio")]
 pub type Default = single::Executor;

src/executor/multi.rs

@@ -1,6 +1,8 @@
 // Copyright 2023 System76 <info@system76.com>
 // SPDX-License-Identifier: MPL-2.0
 
+//! An async executor that schedules tasks across a pol ofbackground thread.
+
 use std::future::Future;
 
 #[cfg(feature = "tokio")]

src/executor/single.rs

@@ -1,6 +1,8 @@
 // Copyright 2023 System76 <info@system76.com>
 // SPDX-License-Identifier: MPL-2.0
 
+//! An async executor that schedules tasks on the same background thread.
+
 use std::future::Future;
 
 #[cfg(feature = "tokio")]

src/font.rs

@@ -1,6 +1,8 @@
 // Copyright 2022 System76 <info@system76.com>
 // SPDX-License-Identifier: MPL-2.0
 
+//! Select preferred fonts.
+
 pub use iced::Font;
 use iced::{
     font::{load, Error},

src/icon_theme.rs

@@ -1,6 +1,8 @@
 // Copyright 2023 System76 <info@system76.com>
 // SPDX-License-Identifier: MPL-2.0
 
+//! Select the preferred icon theme.
+
 use std::cell::RefCell;
 
 thread_local! {

src/keyboard_nav.rs

@@ -1,6 +1,8 @@
 // Copyright 2023 System76 <info@system76.com>
 // SPDX-License-Identifier: MPL-2.0
 
+//! Subscribe to common application keyboard shortcuts.
+
 use iced::{
     event,
     keyboard::{self, KeyCode},

src/theme/mod.rs

@@ -1,6 +1,8 @@
 // Copyright 2022 System76 <info@system76.com>
 // SPDX-License-Identifier: MPL-2.0
 
+//! Use COSMIC's themes and styles.
+
 pub mod expander;
 mod segmented_button;