> On 15 Sep 2015, at 09:41, Paul Rouget <p...@mozilla.com> wrote: > > Until recently, the Browser API had only one consumer (Gaia) and one > implementation (Gecko). > > Now we have a new consumer (browser.html) and a new implementation on > its way (Servo). > > The Browser API has no reference (MDN page is not up to date, and the > WebIDL only list methods, leaving out all the events), so I dug into > the implementation, and collected all the information I could find > about the methods, events and behavior of the Browser API in a single > document: > > https://github.com/paulrouget/mozBrowserAPI/blob/master/BrowserAPI.md > (please help me review it, I haven’t verified everything, and there’s > still some FIXMEs) >
This is really useful Paul - thanks. I feel bad that the Firefox OS APIs are not more up to date on MDN, but we are drowning in documentation work. > Having a central reference would help keeping in sync the 2 > implementations and make documenting the API easier. Yup, having this available for each API would make the job of getting this documented on MDN a lot quicker. > We also want to > suggest some changes to the API, and having such a reference will help > a lot while discussing these changes. This is one reason why documenting Firefox OS is hard - we are drowning in work as it is, even without the APIs changing all the time (I appreciate that it is necessary, but it doesn’t make it any easier ;-) ) > > My question is: how can we keep this reference up to date? Maybe we > could add this document to m-c, and ask reviewers to require the > document to be updated? Or maybe add the comments to the WebIDL and > somehow include the list of authorized events with a definition of > their `details` property into the WebIDL? > If I could just watch this reference for changes and then make the corresponding updates on MDN, this would be a dream come true. Ummm, can we do this for every FxOs API? ;-) > > -- Paul > _______________________________________________ > dev-b2g mailing list > dev-b2g@lists.mozilla.org > https://lists.mozilla.org/listinfo/dev-b2g _______________________________________________ dev-b2g mailing list dev-b2g@lists.mozilla.org https://lists.mozilla.org/listinfo/dev-b2g
