openframeworks / openframeworks/openFrameworks

OSX 0.9.0 release : doxygen generating broken documentation

Open
#4,584 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation
Dominant language
C++
Stars
10.4k
Forks
2.6k
Avg merge
1d 21h
Merged PRs (30d)
9

Description

Has anyone else tried to use doxygen at
of_v0.9.0_osx_release/libs/openFrameworksCompiled/project/doxygen
?

The results are missing lots of classes and generally are unusable. Has anyone else had better luck?

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the doxygen setup and generated output under of_v0.9.0_osx_release/libs/openFrameworksCompiled/project/doxygen. Reproduce the documentation generation on OSX and identify why classes are missing; done means the generated documentation is complete and usable.

Written by the indexing model from the issue text.

Assessment

Tech stack
cpp
Domain
documentation
Issue type
Bug
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.