AcademySoftwareFoundation / AcademySoftwareFoundation/OpenImageIO
[DOCS] `ParamValue` is undocumented
Open
- Dominant language
- C++
- Stars
- 2.4k
- Forks
- 698
- Avg merge
- 3d 4h
- Merged PRs (30d)
- 47
Description
I wager the reason to be an [empty newline](https://github.com/AcademySoftwareFoundation/OpenImageIO/blob/badeba07170c7dd496ce808b1f18aca732f8014c/src/include/OpenImageIO/paramlist.h#L77) between doc comment and class definition in `paramlist.h`.
Contributor guide
Research direction
Open src/include/OpenImageIO/paramlist.h at the ParamValue declaration and inspect the spacing between its documentation comment and class definition. Update the documentation so ParamValue is recognized as documented, then verify that the generated API documentation includes it.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100