Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Dox for breathe #41

Merged
merged 3 commits into from
Jul 3, 2018
Merged

Dox for breathe #41

merged 3 commits into from
Jul 3, 2018

Conversation

mmaka1
Copy link

@mmaka1 mmaka1 commented Jul 3, 2018

Adjusting dox generation for sphinx breathe to be included by sof-docs.

Marcin Maka added 3 commits July 3, 2018 11:23
Integration with sof-docs and breathe does not require
to split the output. So write to a single one and refer
later by doxygen groups.

Signed-off-by: Marcin Maka <[email protected]>
Dox groups (modules) enables selective references by breathe.

Signed-off-by: Marcin Maka <[email protected]>
- There is too much undocumented code, so warn about syntax errors
  in the existing dox only.
- Breathe does not understand __attribute__, so preproc this out.

Signed-off-by: Marcin Maka <[email protected]>
@mmaka1 mmaka1 requested a review from lgirdwood July 3, 2018 09:43
@lgirdwood lgirdwood merged commit a845daf into thesofproject:next Jul 3, 2018
@mmaka1 mmaka1 deleted the dox-for-breathe branch July 3, 2018 10:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants