GNOME Bugzilla – Bug 722507
Missing jquery.js when SEARCHENGINE is off
Last modified: 2018-07-30 10:01:56 UTC
When generating documentation for PHP project, there is no jquery.js file in ./doxygen/html/ directory. This makes collapsed sections of generated documentation inaccessible. The dynsections.js is present as expected, only jquery.js is missing. Steps to reproduce: 0. Go to some empty dir 1. Run: doxywizzard Doxygen 2. Uncheck SEARCHENGINE in Expert / HTML 3. Run: doxygen Doxygen 4. jquery.js is missing 5. Check SEARCHENGINE in Expert / HTML 6. Run: doxygen Doxygen 4. jquery.js is present
Hi Josef, I wasn't able to reproduce the problem with the above procedure, and looking at the code the jquery.js is created unconditionally (at least when the HTML output is enabled). Can you check if you see the same behavior when running doxygen from the command line? Does the output that is produced indicate (at the bottom right of each page) that it is generated by Doxygen 1.8.6 or perhaps a much older version?
Created attachment 282838 [details] Configuration file and some input I can confirm this behaviour with doxygen 1.8.6. Expand the attached gz file, and run doxygen in directory example. jquery.js is not copied to example/html when SEARCHENGINE = NO. Note that doxygen does not clear the html directory. If you first test with SEARCHENGINE = YES, jquery.js is copied to example/html. If you then test with SEARCHENGINE = NO without removing jquery.js, it will remain in example/html.
Comment 2 concerns the version of doxygen that I installed with the Synaptic package manager in Ubuntu 14.04. 'doxygen --version' says it's version 1.8.6. Now I've also built doxygen 1.8.6 and 1.8.7 from the tarballs in ftp://ftp.stack.nl/pub/users/dimitri/. Both of them copies jquery.js to the html directory even if SEARCHENGINE = NO. The missing jquery.js is a bug in Ubuntu's doxygen 1.8.6, which is not identical to Doxygen's doxygen 1.8.6! Josef, from where have you got your doxygen 1.8.6?
From Debian packages.
:-( That explains why I cannot reproduce it myself. Can you please inform the package manager about this?
I just tested it again with doxygen 1.8.7 and it is still bugged. And it looks like it is reported already: https://bugs.debian.org/cgi-bin/bugreport.cgi?bug=751727&archived=False&mbox=no
I can't find an Ubuntu bug about this at https://bugs.launchpad.net/ubuntu, but since Ubuntu is based on Debian, I suppose it will be fixed in Ubuntu once it's fixed in Debian. I found the file doxygen-jquery.patch in the archive file https://launchpad.net/ubuntu/+archive/primary/+files/doxygen_1.8.6-2.debian.tar.xz Index: doxygen/src/htmlgen.cpp =================================================================== --- doxygen.orig/src/htmlgen.cpp 2013-11-09 19:18:19.000000000 +0100 +++ doxygen/src/htmlgen.cpp 2013-11-09 19:18:19.000000000 +0100 @@ -1560,6 +1560,7 @@ fprintf(stderr,"Warning: Cannot open file %s for writing\n",fileName.data()); } + if (Config_getBool("GENERATE_TREEVIEW") || Config_getBool("SEARCHENGINE")) { QFile f(dname+"/jquery.js"); if (f.open(IO_WriteOnly)) That patch is the bug, I guess. It's also included in doxygen_1.8.7-3.debian.tar.xz.
Indeed.
As discussed in https://github.com/doxygen/doxygen/pull/734 , Doxygen has moved its issue tracking to https://github.com/doxygen/doxygen/issues All Doxygen tickets in GNOME Bugzilla have been migrated to Github. You can subscribe and participate in the new ticket in Github. You can find the corresponding Github ticket by searching for its Bugzilla ID (number) in Github. Hence I am closing this GNOME Bugzilla ticket. Please use the corresponding ticket in Github instead. Thanks a lot!