commit cf2738109af69f572034147a1aad35a200608180 parent ae02c02f1f71e8e3a5324c4857a03156c0691ad8 Author: Javier Lopez <graulopezjavier@gmail.com> Date: Mon, 6 Jun 2022 07:30:48 -0500 docs: documenting struct members inline #18783 Without the proper comments, doxygen doesn't understand the comment belongs to the struct member: https://www.doxygen.nl/manual/docblocks.html#memberdoc [skip ci] Diffstat:
| M | runtime/doc/dev_style.txt | | | 8 | ++++---- |
1 file changed, 4 insertions(+), 4 deletions(-)
diff --git a/runtime/doc/dev_style.txt b/runtime/doc/dev_style.txt @@ -529,12 +529,12 @@ it is for and how it should be used. > }; If the field comments are short, you can also put them next to the field. But -be consistent within one struct. > +be consistent within one struct, and follow the necessary doxygen style. > struct wininfo_S { - WinInfo *wi_next; /// Next entry or NULL for last entry. - WinInfo *wi_prev; /// Previous entry or NULL for first entry. - Win *wi_win; /// Pointer to window that did the wi_fpos. + WinInfo *wi_next; ///< Next entry or NULL for last entry. + WinInfo *wi_prev; ///< Previous entry or NULL for first entry. + Win *wi_win; ///< Pointer to window that did the wi_fpos. ... };