412368 - SpiderMonkey documentation tracking bug

Status: RESOLVED INCOMPLETE

(Core :: JavaScript Engine, defect)

Description

[Jason Orendorff [:jorendorff]]

SpiderMonkey and the JSAPI are not thoroughly documented; there's a lot of work to do.  Starting points:

http://developer.mozilla.org/en/docs/SpiderMonkey

http://developer.mozilla.org/en/docs/JSAPI_Reference  (lots of red links here)

(Filing this under JavaScript Engine is dubious, but as a practical matter I think there's a lot of missing stuff that only js/src hackers stand any real chance of filling in.)

Comment 1

[Mathew Hodson]

All the dependencies of this are closed, so this can probably be closed now right?

Comment 2

[Steven DeTar [:sdetar]]

Ted do you have thoughts on whether we can close this bug now?

Comment 3

[Ted Campbell [:tcampbell]]

Closing as we have not real plans to do in-depth API documentation, and certainly not on MDN.

Current supported documentation efforts are:

• Fx Source Docs (in-tree) https://firefox-source-docs.mozilla.org/js/index.html
• SMDOC (in-code comments) https://searchfox.org/mozilla-central/search?q=[SMDOC]&path=js%2F
• SpiderMonkey Embedding (standalone GitHub) https://github.com/mozilla-spidermonkey/spidermonkey-embedding-examples