Skip to content

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

@skliper

Description

@skliper

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

Metadata

Metadata

Assignees

Labels

Type

No type

Projects

No projects

Relationships

None yet

Development

No branches or pull requests

Issue actions