diff options
| author | Javier Lopez <graulopezjavier@gmail.com> | 2022-06-06 07:30:48 -0500 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2022-06-06 05:30:48 -0700 |
| commit | cf2738109af69f572034147a1aad35a200608180 (patch) | |
| tree | 873a74ed3bc57f8af8aebd85960df6ac943437a8 | |
| parent | ae02c02f1f71e8e3a5324c4857a03156c0691ad8 (diff) | |
| download | rneovim-cf2738109af69f572034147a1aad35a200608180.tar.gz rneovim-cf2738109af69f572034147a1aad35a200608180.tar.bz2 rneovim-cf2738109af69f572034147a1aad35a200608180.zip | |
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]
| -rw-r--r-- | runtime/doc/dev_style.txt | 8 |
1 files changed, 4 insertions, 4 deletions
diff --git a/runtime/doc/dev_style.txt b/runtime/doc/dev_style.txt index ac4f489bc9..77253e7831 100644 --- 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. ... }; |