kevin/neovim
1
Fork 0
mirror of https://github.com/neovim/neovim.git synced 2024-12-31 17:13:26 -07:00
Code Issues Packages Projects Releases Wiki Activity

docs: documenting struct members inline #18783

Browse Source 
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]
This commit is contained in:
Javier Lopez 2022-06-06 07:30:48 -05:00 committed by GitHub
parent ae02c02f1f
commit cf2738109a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
runtime/doc/dev_style.txt
View File

@ -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.
...
};