Opened 4 years ago

Closed 4 years ago

Last modified 4 years ago

#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):

https://codereview.adblockplus.org/29335457/

Description (last modified by fhd)

Background

#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.

Change History (9)

comment:1 Changed 4 years ago by fhd

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

comment:2 Changed 4 years ago by fhd

  • Blocking 3621 added

comment:3 Changed 4 years ago by fhd

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

comment:4 Changed 4 years ago by fhd

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

comment:5 Changed 4 years ago 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 build.py 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 4 years ago by sergz

  • Blocking 3613 added

comment:7 Changed 4 years ago by fhd

  • Blocking 2595 added

comment:8 Changed 4 years ago by fhd

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

comment:9 Changed 4 years ago 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.

Note: See TracTickets for help on using tickets.