KhronosGroup / KhronosGroup/OpenCL-CLHPP

Improved API Documentation

Open
#333 0 comments 0 reactions 0 assignees View on GitHub
Dominant language
C++
Stars
425
Forks
133
Avg merge
3h 30m
Merged PRs (30d)
1

Description

The API maintained documentation from doxygen isn’t very descriptive, mainly just listing the functions and classes. Would it be worth adding more detailed doxygen documentation? Perhaps in a separate file if the reason is code bloat.

Contributor guide

No contributing guide indexed for this repository

Research direction

Review the current Doxygen-generated API documentation and the repository's Doxygen setup, then determine which public functions and classes need more descriptive guidance. Clarify whether the additions should live in source comments or a separate file; done means the API documentation is meaningfully more descriptive without unacceptable code bloat.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.