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

Remove explicit file name references in doxygen file comments to avoid warnings #1216

Closed
skliper opened this issue Feb 17, 2022 · 0 comments · Fixed by #1217
Closed

Remove explicit file name references in doxygen file comments to avoid warnings #1216

skliper opened this issue Feb 17, 2022 · 0 comments · Fixed by #1217
Assignees
Milestone

Comments

@skliper
Copy link
Contributor

skliper commented Feb 17, 2022

Is your feature request related to a problem? Please describe.
File comment without a filename implies the comments apply to the current file. Adding the file name makes doxygen try to match that file. The issue is there's multiple files with the same name, so doxygen gets confused unless you add full path. Really it's just overhead since the point is to comment the current file.

Sample warning if you make doc from the bundle:

/home/jhageman/cFS/cFS-GitHub/osal/src/os/posix/src/os-impl-binsem.c:22: warning: the name `os-impl-binsem.c' supplied as the second argument in the \file statement matches the following input files:
   /home/jhageman/cFS/cFS-GitHub/osal/src/os/posix/src/os-impl-binsem.c
   /home/jhageman/cFS/cFS-GitHub/osal/src/os/rtems/src/os-impl-binsem.c
   /home/jhageman/cFS/cFS-GitHub/osal/src/os/vxworks/src/os-impl-binsem.c
Please use a more specific name by including a (larger) part of the path!

Describe the solution you'd like
Easiest to just remove the name since for every case the comment applies to the current file

Describe alternatives you've considered
None

Additional context
None

Requester Info
Jacob Hageman - NASA/GSFC

@skliper skliper added the docs label Feb 17, 2022
@skliper skliper added this to the Draco milestone Feb 17, 2022
@skliper skliper self-assigned this Feb 17, 2022
astrogeco added a commit that referenced this issue Feb 24, 2022
Fix #1216, Remove explicit filename doxygen comments
jphickey pushed a commit to jphickey/osal that referenced this issue Aug 10, 2022
jphickey pushed a commit to jphickey/osal that referenced this issue Aug 10, 2022
…ry-diagrams-app-developer-guide

Fix nasa#1216, Update Directory Diagrams in App Developer Guide
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

1 participant