doxygen: subgroup dma_copy() to solve conflict with struct dma_copy {}#2773
Merged
lgirdwood merged 1 commit intothesofproject:masterfrom Apr 16, 2020
Merged
Conversation
Name clash reported by sphinx/breathe: sof-docs/api/dma-drivers-api.rst:6: WARNING: Duplicate declaration, dma_copy Before this commit: - all "dma_copy" links in doxygen pointed to the struct, never to the function, - there was no "dma_copy" link of any kind in sphinx. With this commit: - most "dma_copy" links in doxygen are disambiguited and fixed, see html/dma_8h_source.html for instance, - there are dma_copy links to the struct in sphinx. Once this is a merged, a commit in sof-docs will add the new subgroup and re-add the function to sof-docs/api/dma-drivers-api.rst Fixes: fa8abe1 ("core: dma: Add DMA copy API.") Reference: http://www.doxygen.nl/manual/grouping.html Signed-off-by: Marc Herbert <marc.herbert@intel.com>
![monocodus[bot]](https://avatars.githubusercontent.com/in/28526?s=60&v=4){kind=small}
marc-hb
requested review from
dbaluta,
jajanusz,
lbetlej,
lgirdwood,
mmaka1,
plbossart and
tlauda
as code owners
Collaborator
Author
|
This is the very last sof-docs warning! Once this and two others https://github.com/thesofproject/sof-docs/pulls are merged I have a tested, one-line Makefile change that upgrades sphinx warnings into errors. The only checkpatch WARNING is: line over 80 characters. I tried hard but I could really not wrap this line without making doxygen's output ugly. Tagging @deb-intel |
|
Nice! 😊 |
lgirdwood
approved these changes
Apr 15, 2020
mmaka1
approved these changes
Apr 16, 2020
Member
|
CI known issues |
This was referenced Apr 16, 2020
Merged
Collaborator
Author
|
Collaborator
Author
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
4 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Name clash reported by sphinx/breathe:
sof-docs/api/dma-drivers-api.rst:6: WARNING: Duplicate declaration, dma_copy
Before this commit:
function,
With this commit:
html/dma_8h_source.html for instance,
Once this is a merged, a commit in sof-docs will add the new subgroup
and re-add the function to sof-docs/api/dma-drivers-api.rst
Fixes: fa8abe1 ("core: dma: Add DMA copy API.")
Reference:
http://www.doxygen.nl/manual/grouping.html
Signed-off-by: Marc Herbert marc.herbert@intel.com