detail identifiers in public APIs could say __implementation_defined__
Nobody has claimed this yet.
Assessment
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Newbie friendliness
- 35/100
- Issue type
- Feature
- Clarity
- Mostly clear
- Activity status
- Stale
- Domain
- documentation
Research direction
Start from the public API example and the current BOOST_URL_DOCS workaround in the issue. Trace how docca renders this declaration, then make the generated API output use implementation_defined for the detail identifier and verify that the workaround is no longer needed.
Written by the indexing model from the issue text.
Description
For example here
template<class CharSet>
detail::pct_encoded_bnf<CharSet>
pct_encoded_bnf(
CharSet const& cs,
pct_encoded_str& t) noexcept;
Currently the workaround is to write
template<class CharSet>
#ifdef BOOST_URL_DOCS
__implementation_defined__
#else
detail::pct_encoded_bnf<CharSet>
#endif
pct_encoded_bnf(
CharSet const& cs,
pct_encoded_str& t) noexcept;
- Dominant language
- Python
- Stars
- 20
- Forks
- 25
- 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 boostorg/docca
-
Difficulty 3/5 1-2 days Newbie friendliness 38/100
-
Difficulty 4/5 3-5 days Newbie friendliness 28/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 88/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 82/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
-
enhancement
Difficulty 2/5 1-3 hours Newbie friendliness 72/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 74/100