aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
-rw-r--r--runtime/doc/dev_style.txt8
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.
...
};