search

buffet / kiwmi

A fully programmable Wayland Compositor
Mozilla Public License 2.0
585 stars 22 forks source link

Create documentation #10

Closed Aareon closed 5 years ago

Aareon commented 5 years ago

This is just a proof-of-concept. If you have a preferred way to style this, let me know. Also, let me know if anything is either factually incorrect, too summarized, or too verbose.

First commit is server_init docs

Aareon commented 5 years ago

btw, this is in response to #4

buffet commented 5 years ago

Sorry for the late reply. I think the issue was about user documentation, not docuenting the code (which is something I should do in the future though.

For documentation I would prefer it to have it above the function declaration, using a /** */ style comment. If I add documentation later it would be neat if it would be parsable by some documentation tool (like doxygen).

Also I don't think the documentation for a function needs to include an English translation of every line in the function. Documentation should be about what the function does not how it does it.