Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Write kernel-doc comments for queue.h #84

Closed
jserv opened this issue Mar 4, 2022 · 0 comments · Fixed by #85 or laneser/lab0-c#4
Closed

Write kernel-doc comments for queue.h #84

jserv opened this issue Mar 4, 2022 · 0 comments · Fixed by #85 or laneser/lab0-c#4
Assignees

Comments

@jserv
Copy link
Contributor

jserv commented Mar 4, 2022

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:

  1. Rewrite the comments in file queue.h which follows kernel-doc comments.
  2. 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.
  3. Move q_release_element from file queue.c to queue.h as a static inline function.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
2 participants