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

Doxygen warning: file argument matching multiple files #551

Closed
astrogeco opened this issue Jul 25, 2020 · 1 comment
Closed

Doxygen warning: file argument matching multiple files #551

astrogeco opened this issue Jul 25, 2020 · 1 comment

Comments

@astrogeco
Copy link
Contributor

Describe the bug
Doxygen produces multiple ambiguous file warnings when building the documentation using make doc at the bundle level. For example:

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

See more warnings in this log
warnings.log

To Reproduce
Checkout cFS bundle with submodules.

Copy the sample_defs from cFE into the cfs root directory as well as the Makefile then

make prep
make doc

examine cFS/build/doc/warnings.log

Expected behavior
No warnings about multiple files

Code snips

This code

/**
 * \file     os-impl-binsem.h
 * \ingroup  rtems
 * \author   joseph.p.hickey@nasa.gov
 *
 */

can be replaced with

/*!
 * \file     rtems/inc/os-impl-binsem.h
 * \ingroup  rtems
 * \author   joseph.p.hickey@nasa.gov
 *
 */

System observed on:
Ubuntu running on Docker

Additional context
None

Reporter Info
Gerardo E. Cruz-Ortiz

@skliper
Copy link
Contributor

skliper commented Feb 24, 2022

Duplicate of #1216
Fixed in #1217

@skliper skliper closed this as completed Feb 24, 2022
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
Fix nasa#551, Remove duplicate CFE_TIME_Local1HzISR prototype
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants