Skip to content

Commit 276c63c

Browse files
committed
Documentation updates
1 parent 59810ba commit 276c63c

12 files changed

+533
-333
lines changed

lib/include/elements/element/align.hpp

+18-9
Original file line numberDiff line numberDiff line change
@@ -352,7 +352,8 @@ namespace cycfi::elements
352352
}
353353

354354
/**
355-
* \brief Create an element that is aligned to left and top.
355+
* \brief
356+
* Create an element that is aligned to left and top.
356357
*
357358
* \tparam Subject
358359
* The subject type, must meet the `Element` concept.
@@ -370,7 +371,8 @@ namespace cycfi::elements
370371
}
371372

372373
/**
373-
* \brief Create an element that is aligned to center and top.
374+
* \brief
375+
* Create an element that is aligned to center and top.
374376
*
375377
* \tparam Subject
376378
* The subject type, must meet the `Element` concept.
@@ -388,7 +390,8 @@ namespace cycfi::elements
388390
}
389391

390392
/**
391-
* \brief Create an element that is aligned to right and top.
393+
* \brief
394+
* Create an element that is aligned to right and top.
392395
*
393396
* \tparam Subject
394397
* The subject type, must meet the `Element` concept.
@@ -406,7 +409,8 @@ namespace cycfi::elements
406409
}
407410

408411
/**
409-
* \brief Create an element that is aligned to left and middle.
412+
* \brief
413+
* Create an element that is aligned to left and middle.
410414
*
411415
* \tparam Subject
412416
* The subject type, must meet the `Element` concept.
@@ -424,7 +428,8 @@ namespace cycfi::elements
424428
}
425429

426430
/**
427-
* \brief Create an element that is aligned to center and middle.
431+
* \brief
432+
* Create an element that is aligned to center and middle.
428433
*
429434
* \tparam Subject
430435
* The subject type, must meet the `Element` concept.
@@ -442,7 +447,8 @@ namespace cycfi::elements
442447
}
443448

444449
/**
445-
* \brief Create an element that is aligned to right and middle.
450+
* \brief
451+
* Create an element that is aligned to right and middle.
446452
*
447453
* \tparam Subject
448454
* The subject type, must meet the `Element` concept.
@@ -460,7 +466,8 @@ namespace cycfi::elements
460466
}
461467

462468
/**
463-
* \brief Create an element that is aligned to left and bottom.
469+
* \brief
470+
* Create an element that is aligned to left and bottom.
464471
*
465472
* \tparam Subject
466473
* The subject type, must meet the `Element` concept.
@@ -478,7 +485,8 @@ namespace cycfi::elements
478485
}
479486

480487
/**
481-
* \brief Create an element that is aligned to center and bottom.
488+
* \brief
489+
* Create an element that is aligned to center and bottom.
482490
*
483491
* \tparam Subject
484492
* The subject type, must meet the `Element` concept.
@@ -496,7 +504,8 @@ namespace cycfi::elements
496504
}
497505

498506
/**
499-
* \brief Create an element that is aligned to right and bottom.
507+
* \brief
508+
* Create an element that is aligned to right and bottom.
500509
*
501510
* \tparam Subject
502511
* The subject type, must meet the `Element` concept.

lib/include/elements/element/button.hpp

+11-8
Original file line numberDiff line numberDiff line change
@@ -33,13 +33,14 @@ namespace cycfi::elements
3333
/**
3434
* \struct button_state
3535
*
36-
* \brief A structure to maintain and manage the state of a button.
36+
* \brief
37+
* A structure to maintain and manage the state of a button.
3738
*
38-
* This structure captures the various states that a button can have:
39-
* - `value`: The button's value; 0(off) or 1(on).
40-
* - `hilite`: True if the button is highlighted.
41-
* - `tracking`: True if the mouse button being pressed.
42-
* - `enabled`: True if the button is enabled.
39+
* This structure captures the various states that a button can have:
40+
* - `value`: The button's value; 0(off) or 1(on).
41+
* - `hilite`: True if the button is highlighted.
42+
* - `tracking`: True if the mouse button being pressed.
43+
* - `enabled`: True if the button is enabled.
4344
*/
4445
struct button_state
4546
{
@@ -350,7 +351,8 @@ namespace cycfi::elements
350351
};
351352

352353
/**
353-
* \brief Get the current selection state of the button.
354+
* \brief
355+
* Get the current selection state of the button.
354356
*
355357
* This function uses the `value()` method to get the current selection
356358
* state of the button.
@@ -365,7 +367,8 @@ namespace cycfi::elements
365367
}
366368

367369
/**
368-
* \brief Set the selection state of the button.
370+
* \brief
371+
* Set the selection state of the button.
369372
*
370373
* This function uses the `value()` member function to set the new
371374
* state of the button.

lib/include/elements/element/drag_and_drop.hpp

+2-1
Original file line numberDiff line numberDiff line change
@@ -281,7 +281,8 @@ namespace cycfi::elements
281281
}
282282

283283
/**
284-
* \brief Sets the selected state of the draggable element.
284+
* \brief
285+
* Sets the selected state of the draggable element.
285286
*
286287
* \param state_
287288
* The new selected state (`true`==selected and `false` otherwise).

lib/include/elements/element/element.hpp

+5-4
Original file line numberDiff line numberDiff line change
@@ -184,11 +184,12 @@ namespace cycfi::elements
184184
}
185185

186186
/**
187-
* \brief Constructs an empty `element` instance.
187+
* \brief
188+
* Constructs an empty `element` instance.
188189
*
189-
* This function is used to create an instance of an `element` that is
190-
* effectively empty. This can be useful for creating placeholder or
191-
* default elements within a UI.
190+
* This function is used to create an instance of an `element` that is
191+
* effectively empty. This can be useful for creating placeholder or
192+
* default elements within a UI.
192193
*
193194
* \return
194195
* An instance of an `element` that has no associated properties or

0 commit comments

Comments
 (0)