Ticket #7 (new defect)

Opened 5 years ago

Last modified 4 years ago

Javascript documenting

Reported by: mpo Owned by: mpo
Priority: minor Milestone: 0.5
Component: < Documentation Version: trunk
Keywords: Cc:

Description

We need a javadoc like description for our javascript code.

Additionally it would be nice to find a tool that helps

  • generating docs out of that like javadoc
  • checking if docs were added effecitvelly

Change History

comment:1 Changed 5 years ago by mpo

  • Milestone changed from 0.2 to 0.3
  • we've settled on using jsdoc (and started adding those into the scripts)
  • However:
    • 0.2 binary distribution doesn't yet include the generated HTML
    • so handing over to 0.3 to reconsider adding them then

comment:2 Changed 4 years ago by mpo

  • Milestone changed from 0.3 to 0.5

0.3 didn't include it either, and 0.4 will not do it either (focus on docs on the site in stead)

post 0.4 we might look into this again,

note: jsdoc is still applied and js-comments should be applied accordingly: It's a good help for developers already, it's just not up to a level where it generates automatic useful documentation for general inclusion and distribution.

Note: See TracTickets for help on using tickets.