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

Same function in multiple Tcl namespaces not added (Origin: bugzilla #669758) #4565

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 critical in component general for ---
Reported in version 1.7.6.1 on platform Other
Assigned to:

Original attachment names and IDs:

On 2012-02-09 16:15:42 +0000, wolfgang.kechel@prs.de wrote:

Created attachment 207201
Simple test case of two tiny tcl files and doxygen configuration.

A function being present in two Tcl namespaces is not added for every namespace. Warning messages are created.

/tmp/doxy/b.tcl:15: warning: documented function `b::dowhatw' was not declared or defined.

The output does not contain documentation for :🅱️:dowhat and the function is not added to the specified module.

Problem: This is a nasty shop stopper if you have a function that is present in multiple namespaces, in my case functions like valid, get,...

File a.tcl:
package provide a 1.0.0;

Namespace a

namespace eval ::a {
}

@addtogroup TCL_API

@{

Do something

@param[in] w An argument

proc :🅰️:dowhat {w} {
}

@}


File b.tcl:
package provide b 1.0.0;

Namespace b

namespace eval ::b {
}

@addtogroup TCL_API

@{

Do something

@param[in] w An argument

proc :🅱️:dowhat {w} {
}

@}


Attachment contains very simple example with doxygen configuration file.

On 2012-02-11 22:51:55 +0000, r.zaumseil@freenet.de wrote:

Created attachment 207367
diff against version 799

The patch add the functions to the namespaces and the group.
The adding to the group page is different to the handling in
p.e. cpp files. There will only be the namespace in the group page.

I'm not sure about the implications and I will try to consult
Dimitri one the issue.

On 2012-02-12 19:03:50 +0000, Dimitri van Heesch wrote:

Hi Rene,

The extra condition should be ok for C++ files as well as far as I can see.

I didn't manage to create a similar C++ example were this extra condition is needed though, so I'm not sure yet what is different between Tcl and C++ that would require this for Tcl, but not for C++.

I'll include this change anyway.

On 2012-02-12 19:57:56 +0000, r.zaumseil@freenet.de wrote:

Just a remark. The same code in C++ (two function with same name and
arg list in different namespaces and put with @addtogroup and @{ and @})
gives only the namespaces on the group page. With the patch the code in
tcl gives the namespaces AND the functions on the group page. The last one
seems logical for me.

On 2012-02-13 08:12:13 +0000, wolfgang.kechel@prs.de wrote:

I added the line to my 1.7.6.1 source code and the result is now OK for me (at least for Tcl). I do have something in a different language with namespaces to check the behaviour as well.
Thanks for the fix.

On 2012-02-25 15:37:35 +0000, Dimitri van Heesch wrote:

This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.0. 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.

@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