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

unable to reference a #define in a different project (Origin: bugzilla #635537) #4028

Closed
doxygen opened this Issue Jul 2, 2018 · 0 comments

Comments

Projects
None yet
1 participant
@doxygen
Owner

doxygen commented Jul 2, 2018

status VERIFIED severity normal in component general for ---
Reported in version 1.7.1 on platform Other
Assigned to: Dimitri van Heesch

Original attachment names and IDs:

On 2010-11-22 16:30:01 +0000, Umesh wrote:

If a #define exists in a ProjectA header file, I cannot make doxygen reference the #define from a ProjectB source file. For example...

  • In a ProjectA .h file

/*!
** @def MY_NICE_DEFINE
**
** @brief
** A define in the header file of ProjectA
*/
#define MY_NICE_DEFINE 37

  • In a ProjectB .c file
    /*!
    ** MyFunction
    ** @brief
    ** Do some stuff
    **
    ** Uses @ref MY_NICE_DEFINE in ProjectA
    **
    ** @return
    ** 0 on success
    */
    int MyFunction ()
    {
    .....
    .....
    }

  • will cause doxygen to exhibit the warning "unable to resolve reference to `PROC_ADDR_MSG' for \ref command".

I use tags, ProjectA creates tags, ProjectB references them, most other references, (objects, files, functions), between projects work well.

Using doxygen 1.71 on Linux (Fedora 12). I (will) include the config files used.

On 2010-11-22 16:37:24 +0000, Umesh wrote:

Created attachment 175052
ProjectA config file

On 2010-11-22 16:38:15 +0000, Umesh wrote:

Created attachment 175053
ProjectB config file

On 2010-11-22 16:38:35 +0000, Umesh wrote:

  • sorry, correction; the doxy warning exhibited for the above example is "unable to resolve reference to `MY_NICE_DEFINE' for \ref command".

On 2011-02-04 13:24:36 +0000, John Lancaster wrote:

I can confirm doxygen do not find references to defines defined in a tagfile.

In addition doxygen will not find references to functions or typedefs that appear in the documentation, but will correctly resolve the reference to a typedef in the code. Whereas a reference to a file in the documentation will correctly resolve.

Example:

/*!

  • \brief
  • \ref func - test func.
  • \description
  • \ref IntEnable in IntLib.h returns the value \ref OK of type \ref Result_t.
    */
    extern Result_t func();

Generates the HTML:
Result_t func ( )
^^^^^^^^
func - test func.

Description:
IntEnable in IntLib.h returns the value OK of type Result_t.
######### ^^^^^^^^ ## ########

Where words marked with ^^^^ are hyper-links and those marked #### are not.

On 2011-02-04 13:29:02 +0000, John Lancaster wrote:

(In reply to comment # 4)

I can confirm doxygen do not find references to defines defined in a tagfile.

In addition doxygen will not find references to functions or typedefs that
appear in the documentation, but will correctly resolve the reference to a
typedef in the code. Whereas a reference to a file in the documentation will
correctly resolve.

To clarify I am referring to functions, typedefs and files defined in a tagfile. When they are local to to the project they are all correctly resolved.

On 2011-02-05 18:41:49 +0000, Dimitri van Heesch wrote:

Confirmed. Should be fixed in the next subversion update.

On 2011-03-26 12:48:18 +0000, Dimitri van Heesch wrote:

*** Bug 645742 has been marked as a duplicate of this bug. ***

On 2011-03-28 14:19:16 +0000, Dimitri van Heesch wrote:

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.7.4. Please verify if this is indeed the case. Reopen the
bug if you think it is not fixed and please include any additional information
that you think can be relevant.

On 2011-03-29 11:49:11 +0000, Umesh wrote:

Have tested this issue with doxygen 1.7.4, can confirm that this is fixed.

On 2011-03-30 16:16:02 +0000, Pekka Pessi wrote:

*** Bug 644115 has been marked as a duplicate of this bug. ***

@doxygen doxygen closed this Jul 19, 2018

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment