New JavaScript Runtime Documentation (preview)

Juan Conejero

PixInsight Staff
Sep 2, 2004
8,380
467
57
Valencia, Spain
pixinsight.com
The JavaScript Runtime Documentation project has started. You can see a sample document here:

http://pixinsight.com/doc/pjsr/objects/Matrix/Matrix.html

Since we already have a rather complete PCL documentation, writing documentation for most core JavaScript objects will be relatively easy and fast. The source code for the above document is here:

http://pixinsight.com/doc/src/pjsr/objects/Matrix.pidoc

Note that you need version 1.4.0 of the PixInsight Documentation Compiler script to compile this document. I'll release the new version with its documentation in a few days.
 

georg.viehoever

PTeam Member
Dec 16, 2007
2,133
1
Munich, Germany
Yes, that's going to be very helpful.
When writing this documentation, please do not forget to document the typical structure of scripts (maybe a template for this?), frequent pitfalls (for instance GC), and 3rd party documentation (Javascript standards, tutorial). Not everything is in objects...
Georg