You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
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 modifying queue.c.
Move q_release_element from file queue.c to queue.h as a static inline function.
The text was updated successfully, but these errors were encountered:
File
list.h
follows kernel-doc comments, which allows the generation of API documentation extracted from the comments. However, filequeue.h
does not, and it would be nice to enforce the kernel-doc formatted documentation for functions.Expected outcome:
queue.h
which follows kernel-doc comments.queue.c
: Only one-line summary should be kept as the comments. The programmers should read the generated documentation while modifyingqueue.c
.q_release_element
from filequeue.c
toqueue.h
as a static inline function.The text was updated successfully, but these errors were encountered: