cleanup code docs making them all doxygen capable
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 62/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Stale
- Tech stack
- cpp
- Domain
- documentation
Research direction
Start by reading the documentation in scope.hpp, using the scope_guard case as the reference for Doxygen-ready comments. Update the remaining documentation so it can feed into the project's documentation-generation tooling; done means the relevant comments follow the same Doxygen-capable pattern.
Written by the indexing model from the issue text.
Description
There's a lot of documentation in scope.hpp that needs work. It should be doxygen ready like the scope_guard case so it can feed into doc generation tooling.
This is a decent first issue since it doesn't involve writing code :)
- Dominant language
- C++
- Stars
- 12
- Forks
- 11
- PR merge metrics
- No merged PRs in 30d
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from bemanproject/scope
-
Difficulty 3/5 1-2 days Newbie friendliness 48/100
bemanproject/scope#55 · 1 comment ·
-
Difficulty 4/5 3-5 days Newbie friendliness 32/100
bemanproject/scope#50 ·
-
bemanproject/scope#45 · 1 assignee ·
-
Difficulty 4/5 3-5 days Newbie friendliness 35/100
bemanproject/scope#37 ·
-
Build errors on OSX Open
bemanproject/scope#36 · 4 comments · 1 assignee ·
All issues in bemanproject/scope
Similar issues
-
Difficulty 1/5 Under an hour Newbie friendliness 90/100
AXERA-TECH/ax-llm#77 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
-
bug-unconfirmed
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100
NVIDIA/cuda-samples#453 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
infiniflow/infinity#3502 ·