Write kernel-doc comments for queue.h
jserv opened this issue · 0 comments
jserv commented
File list.h
follows kernel-doc comments, which allows the generation of API documentation extracted from the comments. However, file queue.h
does not, and it would be nice to enforce the kernel-doc formatted documentation for functions.
Expected outcome:
- Rewrite the comments in file
queue.h
which follows kernel-doc comments. - Simplify the comments in file
queue.c
: Only one-line summary should be kept as the comments. The programmers should read the generated documentation while modifyingqueue.c
. - Move
q_release_element
from filequeue.c
toqueue.h
as a static inline function.