Skip to content

Commit 89bb602

Browse files
djoweldjowel
committed
refinements
1 parent b38ca84 commit 89bb602

File tree

4 files changed

+56
-56
lines changed

4 files changed

+56
-56
lines changed

‎lib/include/elements/element/align.hpp

+21-21
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@ namespace cycfi::elements
6868
* A template class to handle horizontal alignment for elements.
6969
*
7070
* \tparam
71-
* Subject Base type, must meet the `concepts::Element` concept,.
71+
* Subject Base type, must meet the `Element` concept.
7272
*/
7373
template <concepts::Element Subject>
7474
class halign_element : public proxy<Subject, align_element_base>
@@ -88,7 +88,7 @@ namespace cycfi::elements
8888
* Aligns the enclosed element (subject) in the x-axis.
8989
*
9090
* \tparam Subject
91-
* The subject type, must meet the `concepts::Element` concept.
91+
* The subject type, must meet the `Element` concept.
9292
*
9393
* \param align
9494
* The alignment value from 0.0 (left) to 1.0 (right).
@@ -111,7 +111,7 @@ namespace cycfi::elements
111111
* Left-aligns the enclosed element (subject).
112112
*
113113
* \tparam Subject
114-
* The subject type, must meet the `concepts::Element` concept.
114+
* The subject type, must meet the `Element` concept.
115115
*
116116
* \param subject
117117
* The subject to be aligned.
@@ -131,7 +131,7 @@ namespace cycfi::elements
131131
* Center-aligns the enclosed element (subject).
132132
*
133133
* \tparam Subject
134-
* The subject type, must meet the `concepts::Element` concept.
134+
* The subject type, must meet the `Element` concept.
135135
*
136136
* \param subject
137137
* The subject to be aligned.
@@ -151,7 +151,7 @@ namespace cycfi::elements
151151
* Right-aligns the enclosed element (subject).
152152
*
153153
* \tparam Subject
154-
* The subject type, must meet the `concepts::Element` concept.
154+
* The subject type, must meet the `Element` concept.
155155
*
156156
* \param subject
157157
* The subject to be aligned.
@@ -172,7 +172,7 @@ namespace cycfi::elements
172172
* a subject.
173173
*
174174
* \tparam Subject
175-
* Subject type, must meet the `concepts::Element` concept.
175+
* Subject type, must meet the `Element` concept.
176176
*
177177
* \param align
178178
* The initial alignment value.
@@ -213,7 +213,7 @@ namespace cycfi::elements
213213
* A template class to handle vertical alignment for elements.
214214
*
215215
* \tparam
216-
* Subject Base type, must meet the `concepts::Element` concept,.
216+
* Subject Base type, must meet the `Element` concept.
217217
*/
218218
template <concepts::Element Subject>
219219
class valign_element : public proxy<Subject, align_element_base>
@@ -233,7 +233,7 @@ namespace cycfi::elements
233233
* Aligns the enclosed element (subject) in the y-axis.
234234
*
235235
* \tparam Subject
236-
* The subject type, must meet the `concepts::Element` concept.
236+
* The subject type, must meet the `Element` concept.
237237
*
238238
* \param align
239239
* The alignment value from 0.0 (top) to 1.0 (bottom).
@@ -256,7 +256,7 @@ namespace cycfi::elements
256256
* Top-aligns the enclosed element (subject).
257257
*
258258
* \tparam Subject
259-
* The subject type, must meet the `concepts::Element` concept.
259+
* The subject type, must meet the `Element` concept.
260260
*
261261
* \param subject
262262
* The subject to be aligned.
@@ -276,7 +276,7 @@ namespace cycfi::elements
276276
* Middle-aligns the enclosed element (subject).
277277
*
278278
* \tparam Subject
279-
* The subject type, must meet the `concepts::Element` concept.
279+
* The subject type, must meet the `Element` concept.
280280
*
281281
* \param subject
282282
* The subject to be aligned.
@@ -296,7 +296,7 @@ namespace cycfi::elements
296296
* Bottom-aligns the enclosed element (subject).
297297
*
298298
* \tparam Subject
299-
* The subject type, must meet the `concepts::Element` concept.
299+
* The subject type, must meet the `Element` concept.
300300
*
301301
* \param subject
302302
* The subject to be aligned.
@@ -317,7 +317,7 @@ namespace cycfi::elements
317317
* a subject.
318318
*
319319
* \tparam Subject
320-
* Subject type, must meet the `concepts::Element` concept.
320+
* Subject type, must meet the `Element` concept.
321321
*
322322
* \param align
323323
* The initial alignment value.
@@ -355,7 +355,7 @@ namespace cycfi::elements
355355
* \brief Create an element that is aligned to left and top.
356356
*
357357
* \tparam Subject
358-
* The subject type, must meet the `concepts::Element` concept.
358+
* The subject type, must meet the `Element` concept.
359359
*
360360
* \param subject
361361
* The subject to be aligned.
@@ -373,7 +373,7 @@ namespace cycfi::elements
373373
* \brief Create an element that is aligned to center and top.
374374
*
375375
* \tparam Subject
376-
* The subject type, must meet the `concepts::Element` concept.
376+
* The subject type, must meet the `Element` concept.
377377
*
378378
* \param subject
379379
* The subject to be aligned.
@@ -391,7 +391,7 @@ namespace cycfi::elements
391391
* \brief Create an element that is aligned to right and top.
392392
*
393393
* \tparam Subject
394-
* The subject type, must meet the `concepts::Element` concept.
394+
* The subject type, must meet the `Element` concept.
395395
*
396396
* \param subject
397397
* The subject to be aligned.
@@ -409,7 +409,7 @@ namespace cycfi::elements
409409
* \brief Create an element that is aligned to left and middle.
410410
*
411411
* \tparam Subject
412-
* The subject type, must meet the `concepts::Element` concept.
412+
* The subject type, must meet the `Element` concept.
413413
*
414414
* \param subject
415415
* The subject to be aligned.
@@ -427,7 +427,7 @@ namespace cycfi::elements
427427
* \brief Create an element that is aligned to center and middle.
428428
*
429429
* \tparam Subject
430-
* The subject type, must meet the `concepts::Element` concept.
430+
* The subject type, must meet the `Element` concept.
431431
*
432432
* \param subject
433433
* The subject to be aligned.
@@ -445,7 +445,7 @@ namespace cycfi::elements
445445
* \brief Create an element that is aligned to right and middle.
446446
*
447447
* \tparam Subject
448-
* The subject type, must meet the `concepts::Element` concept.
448+
* The subject type, must meet the `Element` concept.
449449
*
450450
* \param subject
451451
* The subject to be aligned.
@@ -463,7 +463,7 @@ namespace cycfi::elements
463463
* \brief Create an element that is aligned to left and bottom.
464464
*
465465
* \tparam Subject
466-
* The subject type, must meet the `concepts::Element` concept.
466+
* The subject type, must meet the `Element` concept.
467467
*
468468
* \param subject
469469
* The subject to be aligned.
@@ -481,7 +481,7 @@ namespace cycfi::elements
481481
* \brief Create an element that is aligned to center and bottom.
482482
*
483483
* \tparam Subject
484-
* The subject type, must meet the `concepts::Element` concept.
484+
* The subject type, must meet the `Element` concept.
485485
*
486486
* \param subject
487487
* The subject to be aligned.
@@ -499,7 +499,7 @@ namespace cycfi::elements
499499
* \brief Create an element that is aligned to right and bottom.
500500
*
501501
* \tparam Subject
502-
* The subject type, must meet the `concepts::Element` concept.
502+
* The subject type, must meet the `Element` concept.
503503
*
504504
* \param subject
505505
* The subject to be aligned.

‎lib/include/elements/element/button.hpp

+9-9
Original file line numberDiff line numberDiff line change
@@ -148,9 +148,9 @@ namespace cycfi::elements
148148
* a momentary button from a given styler.
149149
*
150150
* The function uses two template parameters: `Base` and `Styler`. The
151-
* `Base` should be a momentary button that adheres to `concepts::
152-
* MomentaryButton` with `basic_button` as the default type. The
153-
* `Styler` should follow the `concepts::Element`.
151+
* `Base` should be a momentary button that adheres to `
152+
* MomentaryButton` concept with `basic_button` as the default type.
153+
* The `Styler` should follow the `Element` concept.
154154
*
155155
* \param styler
156156
* An rvalue reference to the styler that will be used to render the
@@ -245,9 +245,9 @@ namespace cycfi::elements
245245
* toggle button from a given styler.
246246
*
247247
* The function uses two template parameters: `Base` and `Styler`. The
248-
* `Base` should be a toggle button that adheres to `concepts::
249-
* ToggleButton` with `basic_toggle_button` as the default type. The
250-
* `Styler` should follow the `concepts::Element`.
248+
* `Base` should be a toggle button that adheres to ` ToggleButton`
249+
* concept with `basic_toggle_button` as the default type. The `Styler`
250+
* should follow the `Element` concept.
251251
*
252252
* \param styler
253253
* An rvalue reference to the styler that will be used to render the
@@ -303,9 +303,9 @@ namespace cycfi::elements
303303
* latching button from a given styler.
304304
*
305305
* The function uses two template parameters: `Base` and `Styler`. The
306-
* `Base` should be a latching button that adheres to `concepts::
307-
* LatchingButton` with `basic_latching_button` as the default type.
308-
* The `Styler` should follow the `concepts::Element`.
306+
* `Base` should be a latching button that adheres to `LatchingButton`
307+
* concept with `basic_latching_button` as the default type. The
308+
* `Styler` should follow the `Element` concept.
309309
*
310310
* \param styler
311311
* An rvalue reference to the styler that will be used to render the

‎lib/include/elements/element/child_window.hpp

+5-7
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ namespace cycfi::elements
4040
* specified rectangular area.
4141
*
4242
* \tparam Subject
43-
* Subject must meet the `concepts::Element` concept.
43+
* Subject must meet the `Element` concept.
4444
*
4545
* \param bounds
4646
* The boundaries of the child window.
@@ -94,8 +94,8 @@ namespace cycfi::elements
9494
* moves when the element is dragged around.
9595
*
9696
* \tparam Subject
97-
* The type of the subject. The Subject must meet the
98-
* `concepts::Element` concept.
97+
* The type of the subject. The Subject must meet the `Element`
98+
* concept.
9999
*
100100
* \param subject
101101
* The subject element that will be made movable.
@@ -121,8 +121,7 @@ namespace cycfi::elements
121121
* when it is clicked.
122122
*
123123
* \tparam Subject
124-
* The type of the subject. Must satisfy the `concepts::Element`
125-
* concept.
124+
* The type of the subject. Must satisfy the `Element` concept.
126125
*/
127126
template <concepts::Element Subject>
128127
class closable_element : public proxy<Subject>
@@ -143,8 +142,7 @@ namespace cycfi::elements
143142
* click event.
144143
*
145144
* \tparam Subject
146-
* The type of the subject. Must satisfy the `concepts::Element`
147-
* concept.
145+
* The type of the subject. Must satisfy the `Element` concept.
148146
*
149147
* \param subject
150148
* The element that is to be made closable.

‎lib/include/elements/element/gallery/dialog.hpp

+21-19
Original file line numberDiff line numberDiff line change
@@ -101,12 +101,12 @@ namespace cycfi::elements
101101
*
102102
* This function constructs a popup dialog with the content passed to
103103
* it. The content is wrapped in a modal and aligned at the center. The
104-
* `dialog0` function accepts content that satisfies the
105-
* `concepts::Element` concept. The constructed dialog is then wrapped
106-
* in a shared pointer and returned.
104+
* `dialog0` function accepts content that satisfies the `Element`
105+
* concept. The constructed dialog is then wrapped in a shared pointer
106+
* and returned.
107107
*
108108
* \tparam Content
109-
* Content type for the dialog. Must satisfy `concepts::Element`.
109+
* Content type for the dialog. Must satisfy `Element`.
110110
*
111111
* \param content
112112
* Content to be displayed in the dialog.
@@ -253,9 +253,9 @@ namespace cycfi::elements
253253
* Note: Install an `on_click` callback before calling `dialog1`.
254254
*
255255
* \tparam Content
256-
* Content type for the dialog. Must satisfy `concepts::Element`.
256+
* Content type for the dialog. Must satisfy `Element`.
257257
* \tparam BtnPtr
258-
* Button type for the dialog. Must satisfy `concepts::ElementPtr`.
258+
* Button type for the dialog. Must satisfy `ElementPtr`.
259259
*
260260
* \param view_
261261
* Reference to the view where the dialog will be displayed.
@@ -299,10 +299,10 @@ namespace cycfi::elements
299299
* user-defined action (specified by the `on_ok` parameter).
300300
*
301301
* \tparam Content
302-
* Content type for the dialog. Must satisfy `concepts::Element`.
302+
* Content type for the dialog. Must satisfy `Element`.
303303
* \tparam F
304304
* Callable type for the 'OK' button click action. Must satisfy
305-
* `concepts::NullaryFunction`.
305+
* `NullaryFunction`.
306306
*
307307
* \param view_
308308
* Reference to the view where the dialog will be displayed.
@@ -355,9 +355,9 @@ namespace cycfi::elements
355355
* Note: Install `on_click` callbacks before calling `dialog2`.
356356
*
357357
* \tparam Content
358-
* Content type. Has to satisfy `concepts::Element`.
358+
* Content type. Has to satisfy `Element`.
359359
* \tparam ButtonPtr
360-
* Button type. Must satisfy `concepts::ElementPtr`.
360+
* Button type. Must satisfy `ElementPtr`.
361361
*
362362
* \param view_
363363
* Reference to the view to display the dialog.
@@ -413,13 +413,14 @@ namespace cycfi::elements
413413
* parameter.
414414
*
415415
* \tparam Content
416-
* The type of the content. The type must satisfy `concepts::Element`.
416+
* The type of the content. The type must satisfy the `Element`
417+
* concept.
417418
* \tparam F1
418419
* The type of `on_ok` function. The type must be
419-
* `concepts::NullaryFunction`.
420+
* `NullaryFunction`.
420421
* \tparam F2
421422
* The type of `on_cancel` function. The type must be
422-
* `concepts::NullaryFunction`.
423+
* `NullaryFunction`.
423424
*
424425
* \param view_
425426
* Reference to the view for displaying the dialog.
@@ -485,10 +486,10 @@ namespace cycfi::elements
485486
* action associated with the `cancel_button`.
486487
*
487488
* \tparam Content
488-
* The type of content to be displayed. The type must satisfy
489-
* `concepts::Element`.
489+
* The type of content to be displayed. The type must satisfy the
490+
* `Element` concept.
490491
* \tparam ButtonPtr
491-
* The type of the button. The type must satisfy `concepts::ElementPtr`.
492+
* The type of the button. The type must satisfy the `ElementPtr` concept.
492493
*
493494
* \param view_
494495
* Reference to the view to display the dialog.
@@ -546,13 +547,14 @@ namespace cycfi::elements
546547
* the `on_ok` parameter.
547548
*
548549
* \tparam Content
549-
* The type of the content. The type must satisfy `concepts::Element`.
550+
* The type of the content. The type must satisfy the `Element`
551+
* concept.
550552
* \tparam F1
551553
* The type of `on_ok` function. The type must be
552-
* `concepts::NullaryFunction`.
554+
* `NullaryFunction`.
553555
* \tparam F2
554556
* The type of `on_cancel` function. The type must be
555-
* `concepts::NullaryFunction`.
557+
* `NullaryFunction`.
556558
*
557559
* \param view_
558560
* Reference to the view to display the dialog.

0 commit comments

Comments
 (0)