Enhance code documentation #55

Closed
opened 2026-02-15 20:17:59 +00:00 by luca0N · 1 comment
Owner

There is no documentation for functions in the server code, and there's some stuff in the client that is also not documented. Functions should have some form of documentation to enhance the code readability. The liblanbassador library, however, is properly documented.

  • Add missing code documentation in the client
  • Add code documentation for the server (#60)
There is no documentation for functions in the server code, and there's some stuff in the client that is also not documented. Functions should have some form of documentation to enhance the code readability. The `liblanbassador` library, however, is properly documented. - [x] Add missing code documentation in the client - [x] Add code documentation for the server (#60)
luca0N self-assigned this 2026-02-15 20:17:59 +00:00
luca0N added this to the v1.0.0 project 2026-02-15 20:17:59 +00:00
Author
Owner

I am not sure whether Go has its own conventions on how functions should be documented, but I am thinking of just using the standard Javadoc format, as used in liblanbassador.

I am not sure whether Go has its own conventions on how functions should be documented, but I am thinking of just using the standard Javadoc format, as used in liblanbassador.
Sign in to join this conversation.
No milestone
No project
No assignees
1 participant
Notifications
Due date
The due date is invalid or out of range. Please use the format "yyyy-mm-dd".

No due date set.

Depends on
Reference
luca0N/lanbassador#55
No description provided.