[Date Prev][Date Next] [Thread Prev][Thread Next] [Date Index] [Thread Index]

Bug#809525: libapt-pkg-doc: Missing javascript in Doxygen-generated HTML documentation?



Control: reassign -1 doxygen 1.8.9.1-6

On Thu, Dec 31, 2015 at 07:04:26PM +0100, Hilko Bengen wrote:
> the file dynsections.js is missing from the Doxygen-generated
> documentation, making it impossible to read large parts of the API docs
> that are hidden.
> 
> The weird thing is that doc/Doxyfile.in contains the following:
> 
> ,----
> | # If the HTML_DYNAMIC_SECTIONS tag is set to YES then the generated HTML
> | # documentation will contain sections that can be hidden and shown after the
> | # page has loaded.
> | # The default value is: NO.
> | # This tag requires that the tag GENERATE_HTML is set to YES.
> | 
> | HTML_DYNAMIC_SECTIONS  = NO
> `----
> 
> ... so perhaps Doxygen didn't behave as intended during package build.

Additionally, even if this option is enabled this javascript file is
still missing. With 'NO' e.g. sections like "Public Member Functions
inherited from FOOBAR" are collapsed by default and can't be open as it
uses a toggleInherit function which is nowhere defined.  If it is set to
'YES' further elements are collapsed like the inheritance diagram, so
the option has an effect after all.

src:apt has SEARCHENGINE set to 'NO' in its configuration, which seems
to be the culpit as if I change it to the (default value) 'YES'
dynsections.js (among many other javascript files) is generated.

Hence the reassigning to doxygen as this looks like a regression or it
is at least totally not obvious why a searchengine setting should effect
collapsible sections ('suddenly' as in the stable version
libapt-pkg-doc still has the javascript file).


On a related sidenote: It would be nice if dynamic sections would be
open by default and collapsed on page load by javascript. The inherit
elements are e.g. all styled with the '.inherit' css class which just
sets 'display:none'. Not setting it via css but doing something like
$('.inherit').hide(0) would be nicer in case of bugs like this one and
also for users who have javascript disabled by default.


Best regards

David Kalnischkies

Attachment: signature.asc
Description: PGP signature


Reply to: