openframeworks / openframeworks/openFrameworks
the deprecation macros break the documentation
Open
Nobody has claimed this yet.
bug
documentation
prelim-analysis
- Dominant language
- C++
- Stars
- 10.4k
- Forks
- 2.6k
- Avg merge
- 1d 21h
- Merged PRs (30d)
- 9
Description
doxygen can't parse that kind of macro correctly so those functions break the docs.
by now i've just removed everything deprecated
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 by locating the deprecated macros and the Doxygen-generated documentation they affect; no file or test path is provided in the issue. Reproduce the documentation failure and verify that deprecated functions are parsed without breaking the generated docs, while preserving the intended deprecation information.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- cpp
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Needs clarification
- Newbie friendliness
- 20/100