[DOCU] Code Documentation and Error Output #4

Open
opened 2022-02-06 12:38:17 +01:00 by fl0kie · 1 comment
Collaborator

The Documentation is essential for the understanding of the code and for looking up, if something breaks. Additionally in sourcecode we have to clear out unclear code section with meaningful comments.

Becuz of that @fl0kie takes care of that for now, because he's into python.

The documentation should be created in an suited form, e.g. markdown directly in gitlab or LaTeX (intensive work at base structure)

The Documentation is essential for the understanding of the code and for looking up, if something breaks. Additionally in sourcecode we have to clear out unclear code section with meaningful comments. Becuz of that @fl0kie takes care of that for now, because he's into python. The documentation should be created in an suited form, e.g. markdown directly in gitlab or LaTeX (intensive work at base structure)
fl0kie added this to the stable Documentation/ErrorOutput milestone 2022-02-06 12:38:17 +01:00
fl0kie added the
Documentation
ErrorHandling
Doing
MustHave
HighPrio
labels 2022-02-06 12:38:17 +01:00
Author
Collaborator

or in Doxygen???

or in Doxygen???
fl0kie changed title from [ToDo] Code Documentation and Error Output to [DOCU] Code Documentation and Error Output 2022-02-06 12:43:05 +01:00
fl0kie self-assigned this 2022-02-06 12:46:16 +01:00
Sign in to join this conversation.
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.

Dependencies

No dependencies set.

Reference: hiajen/HSMensaW#4
No description provided.