<xstddef>: document code-emitting function-like macros
Nobody has claimed this yet.
- Dominant language
- C++
- Stars
- 11.1k
- Forks
- 1.7k
- Avg merge
- 4d 15h
- Merged PRs (30d)
- 22
Description
At the end of <xstddef>: https://github.com/microsoft/STL/blob/1d39dfac9929c0d3c405edf6bc7eff26bbe2a26b/stl/inc/xstddef#L293-L422 we define a small system of macros that are used to stamp out small variations of code for particular cv qualifiers, or calling conventions, etc. We go out of our way to avoid these macros in new code, but there are nevertheless some existing uses. It would be nice to document these macros and their usage via comments in the header.
Contributor guide
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.
Research direction
Start in stl/inc/xstddef, at the function-like macro definitions in the referenced lines near the end of the header. Read each macro and its nearby existing uses to understand the variations it generates. Done means comments document the macros and their usage clearly without changing their behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 68/100