docs: Add widget overview

Part-of: <https://gitlab.gnome.org/Incubator/loupe/-/merge_requests/142>
This commit is contained in:
Sophie Herold 2023-03-14 03:53:53 +01:00
parent 1f48e3cf1f
commit 138ab4ffd9

View file

@ -17,6 +17,35 @@
// //
// SPDX-License-Identifier: GPL-3.0-or-later // SPDX-License-Identifier: GPL-3.0-or-later
/*!
# Loupe Image Viewer
Code documentation
# Widget Structure
Simplified widget arrangement including the most important widgets.
- [`LpWindow`]
- [`AdwFlap`]
- [`LpPropertiesView`]
- [`LpImageView`]
- [`LpSlidingView`]
- [`LpImagePage`]
- [`GtkScrolledWindow`]
- [`LpImage`]
- …
[`AdwFlap`]: adw::Flap
[`GtkScrolledWindow`]: gtk::ScrolledWindow
[`LpImagePage`]: widgets::LpImagePage
[`LpImageView`]: widgets::LpImageView
[`LpImage`]: widgets::LpImage
[`LpPropertiesView`]: widgets::LpPropertiesView
[`LpSlidingView`]: widgets::LpSlidingView
[`LpWindow`]: window::LpWindow
*/
use gettextrs::*; use gettextrs::*;
use gtk::gio::{self, prelude::*}; use gtk::gio::{self, prelude::*};