Opened on 02/02/2016 at 04:12:40 PM

Closed on 02/02/2016 at 04:36:33 PM

#3615 closed change (fixed)

Add module prefixes to navigation in generated source code documentation

Reported by: sebastian Assignee: sebastian
Priority: P3 Milestone:
Module: Automation Keywords:
Cc: Blocked By:
Blocking: Platform: Unknown / Cross platform
Ready: yes Confidential: no
Tester: Unknown Verified working: no
Review URL(s):

​https://codereview.adblockplus.org/29335322

Description

Background

Currently the names shown in the navigation, in the generated source code documentation, don't provide any context, i.e. you don't know which module a class or event is from before clicking on it.

Since JSDoc 3.4.0, however, it is possible to configure the default template, which we use, to ​show the longname (including the module prefix) in the navigation.

What to change

Enable templates.default.useLongnameInNav for JSDoc in order to show the longnames in the navigation.

Attachments (0)

Change History (2)

comment:1 Changed on 02/02/2016 at 04:13:55 PM by sebastian

  • Review URL(s) modified (diff)
  • Status changed from new to reviewing

comment:2 Changed on 02/02/2016 at 04:36:33 PM by sebastian

  • Resolution set to fixed
  • Status changed from reviewing to closed

​https://hg.adblockplus.org/buildtools/rev/ff4ea4c5f0a1

Add Comment

Modify Ticket

Change Properties
Action
as closed .
The resolution will be deleted. Next status will be 'reopened'.
to The owner will be changed from sebastian.
Attachments ↑ Description ↑
 
Note: See TracTickets for help on using tickets.