If one wishes to add kernel-doc for, ohletssay, vm_operations_struct,
the html output is somewhat underwhelming.
-/*
+/**
+ * struct vm_operations_struct - Per-VMA methods.
+ *
* These are the virtual MM functions - opening of an area, closing and
* unmapping it (needed to keep files on disk up-to-date etc), pointer
* to the functions called when a no-page or a wp-page exception occurs.
*/
struct vm_operations_struct {
void (*open)(struct vm_area_struct * area);
+ /**
+ * @close: Called when the VMA is being removed from the MM.
+ * Context: User context. May sleep. Caller holds mmap_lock.
+ */
void (*close)(struct vm_area_struct * area);
That 'Context:' marker is not treated the same way as a Context:
heading in a function definition. Adding a blank line between @close
and Context: improves the appearance somewhat, but it's still not
presented in the nicest possible way.
Any thoughts? Do we have examples elsewhere in the kernel of method
tables being documented using kernel-doc?
