lionkor / lionkor/commandline

Add documentation to `Backend` API

Open
#40 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation good first issue
Dominant language
C++
Stars
95
Forks
16
PR merge metrics
No merged PRs in 30d

Description

- [ ] Add *meaningful* doxygen-style documentation to all public `Backend` functions

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start at the public Backend API declarations and identify every public function that lacks meaningful doxygen-style documentation. Update the documentation for all of those functions, with completion defined by the issue checklist being fully satisfied.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
38/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.