Skip to main content

Visit Mozilla.org

User:Nickolay/Interface documentation notes

From MDC

  • For each interface we should document the common usage pattern:
    • Is it intended to be implemented by the user (e.g. nsIObserver)
    • Is it intended to be created via createInstance?
      • Or via getService?
      • If so, what is the contract IDs people can use
    • Or is it obtained from another interface
  • Need a template interface documentation page (rhe closest is nsIFeedProcessor and other feed-related interfaces) and a page explaining how to help with writing interface docs
  • Probably should switch the XPCOM API reference to the new format.. not too important though.
  • Check if Template:InterfaceStatus:Scriptable_yes can automatically put the article in the appropriate category. Same for Frozen interfaces.
Retrieved from "http://developer.mozilla.org/en/docs/User:Nickolay/Interface_documentation_notes"