KhronosGroup / KhronosGroup/OpenCL-Docs
Uniformize comments for enum types in the XML file
- Dominant language
- Python
- Stars
- 420
- Forks
- 131
- Avg merge
- 5d 13h
- Merged PRs (30d)
- 11
Description
Some of the comments in the XML file don't allow a proper attribution to the underlying type. For instance:
```xml
```
It would be more consistent with the rest of the XML file have this:
```xml
```
I would like to see this adopted as a general guideline as it allows gathering more semantic when using the XML file for code generation purposes.
Contributor guide
Research direction
Start by locating the XML source and reviewing existing require comments for enum groups, using the cl_khr_egl_image examples in the issue as the comparison point. Update the comments so they identify the underlying enum type or error-code group consistently, and consider the work done when the XML follows that guideline throughout.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100