Johannes Berg wrote:
Hi Andy,
Thanks for the repost.
+/* Radiotap header iteration
+ * implemented in net/wireless/radiotap.c
+ *
+ * call __ieee80211_radiotap_iterator_init() to init a semi-opaque iterator
+ * struct ieee80211_radiotap_iterator (no need to init the struct beforehand)
+ * then loop calling __ieee80211_radiotap_iterator_next()... it returns -1
+ * if there are no more args in the header, or the next argument type index
+ * that is present. The iterator's this_arg member points to the start of the
+ * argument associated with the current argument index that is present,
+ * which can be found in the iterator's this_arg_index member. This arg
+ * index corresponds to the IEEE80211_RADIOTAP_... defines.
+ */
I don't think this will show up in the kdoc output, but it sure would be
nice. Maybe it could be part of the description of
ieee80211_radiotap_iterator as a 'how to use this iterator' section (see
kernel-doc-nano-HOWTO.txt, it talks about sections)? Or maybe as
kernel-doc for the functions themselves.
+/**
+ * ieee80211_radiotap_iterator_init - radiotap parser iterator initialization
Oh, you have kerneldoc comments in the source file. Does anyone know
which is preferable? I usually put everything into the header file that
is not implementation-detail.
We mostly put kernel-doc into source files (i.e., not header files).
We use kernel-doc in header files for inline functions, macros,
structs, unions, etc., but function kernel-doc blocks are meant to
immediately precede their functions.
--
~Randy
*** Remember to use Documentation/SubmitChecklist when testing your code ***
-
To unsubscribe from this list: send the line "unsubscribe linux-wireless" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
