aau-giraf / web-api

The backend API for GIRAF — a .NET-core project written in C#.
GNU General Public License v3.0
2 stars 5 forks source link

Update code documentation #331

Open andreaskrath opened 11 months ago

andreaskrath commented 11 months ago

Description

There are some parts of the code that do not have extensive and thorough documentation, like:

An example of poor documentation can be seen in the one of the constructors for the Week model.

Resolving this issue would be a large project, as it would involve going through the code base and understanding it thoroughly, before updating the provided descriptions and more.

It is likely that this issue only makes sense to complete after or as part of #326

Possible Suggested Solution