Skip to content

Commit f25aba2

Browse files
Alex2772luadebug
andauthored
MkDocs: Add views screenshots to their description pages + extract them and put to overview page (#595)
* Frontend initialize * update style * Fix card grid spacing: ensure consistent fixed gap between cards in all rows * Do not make it too wide * try to place second page for debug to learn generation of view-cards page * refactor * refactor * adjust styles * drop redundant page * Show 1 card on small screen, 2 on tablet, 3 on pc * make Vertical margin between text adaaptive * fix width of each view card * keep only 2 cards shown max * keep Vertical margin same * fixup * remove margins and widths/heights * keep small bottom margin between cards * Make mouse click area over whole card, not just picture * Repair href for view-cards * Place images next to .h brief descriptions * Refer to brief description to extract image reference for card-view * Repair generation of AView * Gather page url by namespace * wip * wip * wip * wip --------- Co-authored-by: Saikari <lin@sz.cn.eu.org>
1 parent 15fc845 commit f25aba2

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

86 files changed

+551
-146
lines changed

aui.views/src/AUI/View/A2FingerTransformArea.h

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,10 @@ struct A2DTransform {
3131

3232
/**
3333
* @brief Handles and processes the multitouch scale, transform and rotation events based on two-finger gestures.
34-
* @ingroup useful_views
34+
*
35+
* ![](imgs/views/A2FingerTransformArea.png)
36+
*
37+
* @ingroup views_containment
3538
* @details
3639
* Represents a translucent area that handles and processes multi-finger transformation gestures (i.e. pinch-to-zoom,
3740
* move, rotate). A2FingerTransformArea is a container, so the transformed view should be somewhere inside.

aui.views/src/AUI/View/AButton.h

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,10 @@
2323

2424
/**
2525
* @brief Button with text, which can be pushed to make some action.
26-
* @ingroup useful_views
26+
*
27+
* ![](imgs/views/AButton.png)
28+
*
29+
* @ingroup views_actions
2730
* @details
2831
* Button is a fundamental view which can be pushed to make some action.
2932
*

aui.views/src/AUI/View/ACheckBox.h

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,10 @@
1818

1919
/**
2020
* @brief A check box (without label).
21-
* @ingroup useful_views
21+
*
22+
* ![](imgs/views/ACheckBox.png)
23+
*
24+
* @ingroup views_input
2225
* @details
2326
* Checkbox is a checkable button that is typically used to enable/disable some action.
2427
*
@@ -75,7 +78,9 @@ class API_AUI_VIEWS ACheckBox : public AView, public ass::ISelectable {
7578

7679
/**
7780
* @brief View container with a checkbox.
78-
* @ingroup useful_views
81+
*
82+
* ![](imgs/views/ACheckBoxWrapper.png)
83+
* @ingroup views_input
7984
* @details
8085
* For a checkbox itself, see [ACheckBox].
8186
*/

aui.views/src/AUI/View/ACircleProgressBar.h

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,10 @@
1616

1717
/**
1818
* @brief A circle-shaped progress bar.
19-
* @ingroup useful_views
19+
*
20+
* ![](imgs/views/ACircleProgressBar.png)
21+
*
22+
* @ingroup views_indication
2023
* @details
2124
* A progress bar is used to express a long operation (i.e. file copy) with known progress and reassure the user that
2225
* application is still running.

aui.views/src/AUI/View/ADoubleNumberPicker.h

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,10 @@
1919

2020
/**
2121
* @brief A text field for numbers with increase/decrease buttons.
22-
* @ingroup useful_views
22+
*
23+
* ![](imgs/views/ADoubleNumberPicker.png)
24+
*
25+
* @ingroup views_input
2326
*/
2427
class API_AUI_VIEWS ADoubleNumberPicker : public AViewContainerBase {
2528
private:

aui.views/src/AUI/View/ADragArea.h

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,11 @@
2020

2121
/**
2222
* @brief Wrapping container to drag views inside of it.
23+
*
24+
* ![](imgs/views/ADragArea.png)
25+
*
2326
* @details Contained views must be either wrapped by convertToDraggable or have an ADragArea::ADraggableHandle inside.
24-
* @ingroup useful_views
27+
* @ingroup views_containment
2528
*/
2629
class API_AUI_VIEWS ADragArea: public AViewContainer {
2730
private:

aui.views/src/AUI/View/ADrawableView.h

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,10 @@
2121

2222
/**
2323
* @brief Simple view to draw an IDrawable.
24-
* @ingroup useful_views
24+
*
25+
* ![](imgs/views/ADrawableView.png)
26+
*
27+
* @ingroup views_indication
2528
* @details
2629
* ADrawableView brings you more control over the drawable. This is useful for drawables with extended interface
2730
* (i.e., AAnimatedImage).

aui.views/src/AUI/View/ADropdownList.h

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,10 @@
2222

2323
/**
2424
* @brief A button with dropdown list.
25-
* @ingroup useful_views
25+
*
26+
* ![](imgs/views/ADropdownList.png)
27+
*
28+
* @ingroup views_input
2629
*/
2730
class API_AUI_VIEWS ADropdownList: public AButton {
2831
private:

aui.views/src/AUI/View/AForEachUI.h

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -129,7 +129,10 @@ concept RangeFactory = requires(Factory&& factory) {
129129

130130
/**
131131
* @brief Customizable lists display.
132-
* @ingroup useful_views
132+
*
133+
* ![](imgs/views/AForEachUI.png)
134+
*
135+
* @ingroup views_containment
133136
* @details
134137
* Used to lazily present possibly large or infinite linear non-hierarchical sequences of data.
135138
*

aui.views/src/AUI/View/AGridSplitter.h

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,10 @@
1818

1919
/**
2020
* @brief A resizable grid layout.
21-
* @ingroup useful_views
21+
*
22+
* ![](imgs/views/AGridSplitter.png)
23+
*
24+
* @ingroup views_containment
2225
* @details
2326
* AGridSplitter represents a grid layout which can be resized by user. Unlike ASplitter, works in both directions.
2427
* AGridSplitter can be constructed with AGridSplitter::Builder.

0 commit comments

Comments
 (0)