Opened 12 years ago

Closed 11 years ago

#1010 closed defect (fixed)

Documentation: JSdoc

Reported by: ray Owned by: akaEdge
Priority: normal Milestone: Version 1.0
Component: Documentation Version: trunk
Severity: normal Keywords:
Cc:

Description

As anyone will have noticed: Xinha's documentation is still poor. I've been going through the code (of XinhaCore.js) and added JSdoc comments to each property and method, so that now more people have the chance to make their way through the jungle :) (I hope...)

Change History (2)

comment:1 Changed 12 years ago by ray

  • Milestone set to Version 1.0
  • Version set to trunk

You can view the generated documentation at
http://xinha.raimundmeyer.de/JSdoc/Xinha/
and
http://xinha.raimundmeyer.de/JSdoc/XinhaWithPrivates/

I ask anybody who can to improve this[[BR]]

Obviously file size hase increased considerably through the inline documentation, so I want to point out the existence of the compression script in contrib/comression.php.

comment:2 Changed 11 years ago by ray

  • Resolution set to fixed
  • Status changed from new to closed
Note: See TracTickets for help on using tickets.