After an evaluation, GNOME has moved from Bugzilla to GitLab. Learn more about GitLab.
No new issues can be reported in GNOME Bugzilla anymore.
To report an issue in a GNOME project, go to GNOME GitLab.
Do not go to GNOME Gitlab for: Bluefish, Doxygen, GnuCash, GStreamer, java-gnome, LDTP, NetworkManager, Tomboy.
Bug 635537 - unable to reference a #define in a different project
unable to reference a #define in a different project
Status: VERIFIED FIXED
Product: doxygen
Classification: Other
Component: general
1.7.1
Other Linux
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
: 644115 645742 (view as bug list)
Depends on:
Blocks:
 
 
Reported: 2010-11-22 16:30 UTC by Umesh
Modified: 2011-03-30 16:16 UTC
See Also:
GNOME target: ---
GNOME version: ---


Attachments
ProjectA config file (11.73 KB, text/plain)
2010-11-22 16:37 UTC, Umesh
Details
ProjectB config file (11.78 KB, text/plain)
2010-11-22 16:38 UTC, Umesh
Details

Description Umesh 2010-11-22 16:30:01 UTC
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.
Comment 1 Umesh 2010-11-22 16:37:24 UTC
Created attachment 175052 [details]
ProjectA config file
Comment 2 Umesh 2010-11-22 16:38:15 UTC
Created attachment 175053 [details]
ProjectB config file
Comment 3 Umesh 2010-11-22 16:38:35 UTC
- sorry, correction; the doxy warning exhibited for the above example is "unable to resolve reference to `MY_NICE_DEFINE' for \ref command".
Comment 4 John Lancaster 2011-02-04 13:24:36 UTC
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.
Comment 5 John Lancaster 2011-02-04 13:29:02 UTC
(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.
Comment 6 Dimitri van Heesch 2011-02-05 18:41:49 UTC
Confirmed. Should be fixed in the next subversion update.
Comment 7 Dimitri van Heesch 2011-03-26 12:48:18 UTC
*** Bug 645742 has been marked as a duplicate of this bug. ***
Comment 8 Dimitri van Heesch 2011-03-28 14:19:16 UTC
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.
Comment 9 Umesh 2011-03-29 11:49:11 UTC
Have tested this issue with doxygen 1.7.4, can confirm that this is fixed.
Comment 10 Pekka Pessi 2011-03-30 16:16:02 UTC
*** Bug 644115 has been marked as a duplicate of this bug. ***