Difference between revisions of "Documenting Interface Reference Documents"

From CDOT Wiki
Jump to: navigation, search
(Project Contributor(s))
(Release 0.2)
Line 30: Line 30:
 
===      Release 0.2 ===
 
===      Release 0.2 ===
 
'''Goals: Document the following Public Places Interfaces'''
 
'''Goals: Document the following Public Places Interfaces'''
* nsIAnnotationService.idl
+
* [http://developer.mozilla.org/en/docs/nsIAnnotationService nsIAnnotationService]
 
* nsIBrowserHistory.idl
 
* nsIBrowserHistory.idl
 
* nsIDynamicContainer.idl
 
* nsIDynamicContainer.idl

Revision as of 12:45, 16 November 2007

Project Name

Documenting Interface Reference Documents

Project Description

Mozilla is comprised of a number of interfaces that are used for programming it and for writing add-ons for it. And majority of them are undocumented. Therefore i would be sitting down and reading files that contain information about certain interfaces (IDL - Interface Definition Files) and transcribing that information into "Interface Reference Documents Format".

(See: http://developer.mozilla.org/en/docs/MDC:Writing_interface_reference_documentation)

Project Leader

Project Contributor(s)

Project Details

Release 0.1

Goals: Document the following Storage API Interfaces

Basically, the first thing that needs to be done is to start reading about the Storage API. Then read into the Storage API IDL files that contain information about set of interfaces that lets extensions store data in a local database.

After that I will start documenting some of the Storage API IDL's into the MDC - Interfaces Documentation section.

Release 0.2

Goals: Document the following Public Places Interfaces

  • nsIAnnotationService
  • nsIBrowserHistory.idl
  • nsIDynamicContainer.idl
  • nsIFaviconService.idl
  • nsILivemarkService.idl
  • nsINavBookmarksService.idl
  • nsINavHistoryService.idl
  • nsITaggingService.idl

Basically, the first thing that needs to be done is to start reading about these "Places" IDL files.

After that I will start documenting these IDL's into the MDC - Interfaces Documentation section.

Release 0.3

Project News