arsdever / arsdever/lcd

[imp] Add some documentation

Open
#72 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
C++
Stars
2
Forks
1
PR merge metrics
No merged PRs in 30d

Description

### Description
The code lacks in-code documentation and it's necessary to be added. It will not only improve the development process of the other contributors but also can be used later for the documentation generation process. Proper guidelines should be defined on where and how to put the in-code documentation and the format which needs to be followed.

### Expectation
The code is properly documented with in-code documentation.

Contributor guide

No contributing guide indexed for this repository

Research direction

No files, tests, or entry points are named. Start by surveying the C++ codebase and its existing comments to determine the documentation scope and conventions; done means the agreed guidelines are defined and the relevant code has consistent in-code documentation suitable for later generation.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation, embedded-iot
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
20/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.