From 138ab4ffd9ff05d5f6f9dfff34a0a4934f190d4a Mon Sep 17 00:00:00 2001
From: Sophie Herold <sophie@hemio.de>
Date: Tue, 14 Mar 2023 03:53:53 +0100
Subject: [PATCH] docs: Add widget overview

Part-of: <https://gitlab.gnome.org/Incubator/loupe/-/merge_requests/142>
---
 src/main.rs | 29 +++++++++++++++++++++++++++++
 1 file changed, 29 insertions(+)

diff --git a/src/main.rs b/src/main.rs
index 9cfd20f..07f3687 100644
--- a/src/main.rs
+++ b/src/main.rs
@@ -17,6 +17,35 @@
 //
 // 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 gtk::gio::{self, prelude::*};