Opened on 02/03/2016 at 09:49:41 AM

Closed on 02/05/2016 at 05:03:30 PM

Last modified on 02/05/2016 at 05:03:37 PM

#3618 closed change (fixed)

Generate JSDoc documentation for adblockpluscore

Reported by: fhd Assignee: fhd
Priority: P2 Milestone:
Module: Core Keywords:
Cc: sebastian Blocked By: #2594
Blocking: #2595, #3613, #3621 Platform: Unknown / Cross platform
Ready: yes Confidential: no
Tester: Unknown Verified working: no
Review URL(s):

Description (last modified by fhd)


#2594 moves the core code to a separate repository, adblockpluscore. Because of that, the JSDoc documentation for that code won't be generated along with the ABP for Firefox code any more. We need to generate it separately.

What to change

Add a script that generates the docs using buildtools, analogous to how it works in adblockplus.

Attachments (0)

Change History (9)

comment:1 Changed on 02/03/2016 at 10:10:41 AM by fhd

  • Component changed from Adblock-Plus-for-Firefox to Core

comment:2 Changed on 02/03/2016 at 10:29:49 AM by fhd

  • Blocking 3621 added

comment:3 Changed on 02/03/2016 at 10:48:43 AM by fhd

  • Description modified (diff)
  • Summary changed from Generate jsdoc for adblockpluscore to Generate JSDoc documentation for adblockpluscore

comment:4 Changed on 02/03/2016 at 11:00:04 AM by fhd

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

comment:5 Changed on 02/03/2016 at 11:02:13 AM by sebastian

  • Cc sebastian added

I'm not sure whether we need to add script to the repository therefore. Note that even for the repositories that have a script that can be used to generate the documentation (i.e. adblockplus and adblockpluschrome), sitescripts doesn't use it, but uses buildtools directly.

comment:6 Changed on 02/03/2016 at 11:53:51 AM by sergz

  • Blocking 3613 added

comment:7 Changed on 02/04/2016 at 12:17:18 PM by fhd

  • Blocking 2595 added

comment:8 Changed on 02/05/2016 at 05:03:30 PM by fhd

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

comment:9 Changed on 02/05/2016 at 05:03:37 PM by fhd

Sebastian: Sorry, missed your comment before. IMHO this logic belongs into the individual repository, since they're generating docs in slightly different ways (libadblockplus even does it in a completely different way). My current approach to #1299 is to run an external command specified in sitescripts.ini for that. But let's move the discussion there I guess, I will soon have a patch up with that.

Add Comment

Modify Ticket

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