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 675036 - File List is confused when SHOW_FILES option is disabled
File List is confused when SHOW_FILES option is disabled
Status: RESOLVED FIXED
Product: doxygen
Classification: Other
Component: general
1.8.0
Other Windows
: Normal normal
: ---
Assigned To: Dimitri van Heesch
Dimitri van Heesch
Depends on:
Blocks:
 
 
Reported: 2012-04-28 18:57 UTC by Adam Gabryś
Modified: 2012-06-10 09:41 UTC
See Also:
GNOME target: ---
GNOME version: ---



Description Adam Gabryś 2012-04-28 18:57:02 UTC
Hello,
I think File List is confused when SHOW_FILES option is disabled. We can collapse and uncollapse file list, but we cannot click any file. To see anything we must first click on "File List" and next choose file (click [code]). I think it will be better when user can see code, when he/she click on it name.
I upload sample documentation on my website: http://www.adam.gabrys.biz/v/2012-04-28/doxygen/file-list/
Comment 1 Dimitri van Heesch 2012-05-03 18:47:32 UTC
Confirmed. Should already be fixed in the current subversion snapshot.
Comment 2 Dimitri van Heesch 2012-05-19 12:27:09 UTC
This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.1. 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 3 Adam Gabryś 2012-05-20 16:18:50 UTC
I think that doxygen v1.8.1 generates documentation, which confuses user when SHOW_USED_FILES=YES and SHOW_FILES=NO.

I upload sample documentation on my website:
http://www.adam.gabrys.biz/v/2012-05-20/doxygen/file-list/

Example:
User open Parent class (http://www.adam.gabrys.biz/v/2012-05-20/doxygen/file-list/apidocs/html/class_parent.html) and next click URL "Parent.js" (http://www.adam.gabrys.biz/v/2012-05-20/doxygen/file-list/apidocs/html/_parent_8js_source.html). Why menu is empty?

I think the better solution for this problem would be to add links to files name in the list. I modified files.js from previous documentation (2012-04-28): http://www.adam.gabrys.biz/v/2012-05-20/doxygen/file-list/apidocs-better/html/files.html. You can click on file name in the list and go to the file.

Changes from:
var files =
[
    [ "Child.js", null, null ],
    [ "MyLib.js", null, null ],
    [ "Parent.js", null, null ]
];
to:
var files =
[
    [ "Child.js", "_child_8js_source.html", null ],
    [ "MyLib.js", "_my_lib_8js_source.html", null ],
    [ "Parent.js", "_parent_8js_source.html", null ]
];
Comment 4 Dimitri van Heesch 2012-05-26 09:40:27 UTC
Hi Adam,

I agree that the navigation tree should not become empty (that's a bug), but your solution is also not what you want if you set SHOW_FILES=NO, because doxygen would still show files like it does when SHOW_FILES=YES. I'll make doxygen just shown the root node with its direct children expanded in this case.
Comment 5 Dimitri van Heesch 2012-06-10 09:41:53 UTC
This bug was previously marked ASSIGNED, which means it should be fixed in
doxygen version 1.8.1.1. 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.