widgets: Add some widget descriptions

This commit is contained in:
Sophie Herold 2023-03-06 22:59:40 +01:00
parent 9535b33b11
commit f12ff1ea4d
4 changed files with 24 additions and 1 deletions

View file

@ -16,6 +16,17 @@
// //
// SPDX-License-Identifier: GPL-3.0-or-later // SPDX-License-Identifier: GPL-3.0-or-later
//! A widget that shows images and handles control inputs
//!
//! This widget handles showing the right section of the image
//! with a spicfic zoom level and rotation. It also handles control
//! input that change those properties.
//!
//! While this widget logically coposes the image, decoding images
//! and composing the textures happens in [`decoder`].
//!
//! [`decoder`]: crate::decoder
use crate::deps::*; use crate::deps::*;
use crate::decoder::{self, tiling, Decoder, DecoderUpdate}; use crate::decoder::{self, tiling, Decoder, DecoderUpdate};

View file

@ -17,6 +17,10 @@
// //
// SPDX-License-Identifier: GPL-3.0-or-later // SPDX-License-Identifier: GPL-3.0-or-later
//! A widget that shows the image, a loading screen, or an error page
//!
//! This widget also handles showing the context menu.
use crate::deps::*; use crate::deps::*;
use crate::widgets::LpImage; use crate::widgets::LpImage;

View file

@ -17,6 +17,14 @@
// //
// SPDX-License-Identifier: GPL-3.0-or-later // SPDX-License-Identifier: GPL-3.0-or-later
//! A widget that shows the [`LpSlidingView`] and coordinates it's content
//!
//! This widget coordinates the content of [`LpSlidingView`] with the
//! [`LpFileModel`]. It also handles input that changes the image.
//!
//! [`LpSlidingView`]: crate::widgets::LpSlidingView
//! [`LpFileModel`]: crate::file_model::LpFileModel
use crate::deps::*; use crate::deps::*;
use crate::file_model::LpFileModel; use crate::file_model::LpFileModel;
use crate::i18n::*; use crate::i18n::*;

View file

@ -1,4 +1,4 @@
//! Sliding view for images //! A sliding view widget for images
//! //!
//! This widget it similar to `AdwCarousel`. //! This widget it similar to `AdwCarousel`.
//! Currently, there is no swipe-gesture support since it's not working with //! Currently, there is no swipe-gesture support since it's not working with