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

A function description is distributed between the source and its header file (Origin: bugzilla #509348) #2786

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

Comments

Projects
None yet
1 participant
@doxygen
Owner

doxygen commented Jul 2, 2018

status RESOLVED severity blocker in component general for ---
Reported in version 1.5.4 on platform Other
Assigned to: Dimitri van Heesch

Original attachment names and IDs:

On 2008-01-14 12:19:02 +0000, Sergey wrote:

C language project

A function call graph and references are put into the header file (where the function prototype with or without 'extern' keyword is located), while the caller graph and referenced by sections are put into the source file with the function definition.
I haven't found any properties to influence on this behavior and consider this as a bug.

Moreover, before the header file was created, the function call graph was put into another source file where the function is used (called), but not defined.

It is possible to provide an example to reproduce the problem, if necessary.

On 2008-01-14 12:25:53 +0000, Sergey wrote:

Created attachment 102806
The test case to reproduce the problem

To reproduce the problem

  1. unpack the archive
  2. in the cintg.dg folder execute make doc
  3. after the documentation is generated, open the index.html from the docs/html folder, open files, find and open get_token.c source file, find description of the eval_exp function: there is no call graph
  4. open the file get_token.h documentation, find there eval_exp function: there is the call graph
    Problem: call and caller graphs must be either in both files or only in the source file, but not separated between two files.

On 2008-01-21 22:19:57 +0000, Dimitri van Heesch wrote:

According to the changelog this problem should have been fixed in 1.5.3-20071008, so before the 1.5.4 release. I see the call graph in the current subversion snapshot (and in 1.5.4) in both the header and the source file, so are you sure you get the problem with release 1.5.4? or did you perhaps use an older version by mistake?

On 2008-01-22 07:30:39 +0000, Sergey wrote:

The version 1.5.4. is the only version I have:
bash-3.1$ doxygen --version
1.5.4

On 2009-08-16 11:06:20 +0000, Dimitri van Heesch wrote:

The problem is with the extra (and redundant) forward declaration
in the .c file. This prevents the actual definition of the function to get the proper attributes. I'll fix this in the next release.

On 2009-08-20 10:12:50 +0000, Dimitri van Heesch wrote:

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

@doxygen doxygen closed this Jul 2, 2018

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