Changes

Jump to: navigation, search

Documenting Interface Reference Documents

4,079 bytes added, 14:44, 15 December 2007
Grammar fixes
== Project Description ==
Mozilla is comprised of a number of many interfaces that are used for programming it and the core as well as for writing add-ons for it. And A majority of them these are currently undocumented. Therefore i would be sitting down This project will seek to document as many interfaces, and reading files that contain information about certain interfaces (IDL - Interface Definition Files) and transcribing that information into "Interface Reference Documents Format"of value to the upcoming Firefox 3 release, as possible.
(SeeReference: http://developer.mozilla.org/en/docs/MDC:Writing_interface_reference_documentation)
== Project Leader ==
== Project Contributor(s) ==
* [[User:vbala|Vijey Balasundaram]]
* [[User:ayhfung|Andrew Fung]]
* [[User:kglee|Kenneth Lee]]
== Project Details ==
=== Release 0.2 ===
'''Goals: Document the following Public Places Interfaces'''
* [http://developer.mozilla.org/en/docs/nsIAnnotationService nsIAnnotationService]* [http://developer.mozilla.org/en/docs/nsIBrowserHistory nsIBrowserHistory]* [http://developer.mozilla.org/en/docs/nsIDynamicContainer nsIDynamicContainer]* [http://developer.mozilla.org/en/docs/nsIFaviconService nsIFaviconService]* [http://developer.mozilla.idlorg/en/docs/nsILivemarkService nsILivemarkService]* nsIBrowserHistory[http://developer.mozilla.idlorg/en/docs/nsINavBookmarksService nsINavBookmarksService]* nsIDynamicContainer[http://developer.mozilla.idlorg/en/docs/nsINavHistoryService nsINavHistoryService]* nsIFaviconService[http://developer.mozilla.idlorg/en/docs/nsITaggingService nsITaggingService]* nsILivemarkService[http://developer.mozilla.idlorg/en/docs/nsIAnnotationObserver nsIAnnotationObserver]* nsINavBookmarksService[http://developer.mozilla.idl org/en/docs/nsINavBookmarkObserver nsINavBookmarkObserver]* nsINavHistoryService[http://developer.mozilla.idlorg/en/docs/nsINavHistoryQuery nsINavHistoryQuery]* nsITaggingService[http://developer.mozilla.idlorg/en/docs/nsINavHistoryQueryOptions nsINavHistoryQueryOptions]
Basically, the first thing that needs to be done is to start reading about these "the [http://developer.mozilla.org/en/docs/Places" Places API]. Then read into the Places API IDL filesthat contain information about Firefox's bookmarks and history system.
After that I will start documenting these IDL's into the [http://developer.mozilla.org/en/docs/Interfaces MDC - Interfaces Documentation] section.
=== Release 0.3 ===
'''Goals: Document the following Public Places Interfaces'''
* [http://developer.mozilla.org/en/docs/mozIStorageDataSet mozIStorageDataSet]
* [http://developer.mozilla.org/en/docs/mozIStorageStatementParams mozIStorageStatementParams]
* [http://developer.mozilla.org/en/docs/mozIStorageStatementRow mozIStorageStatementRow]
* [http://developer.mozilla.org/en/docs/mozIStorageStatementWrapper mozIStorageStatementWrapper]
* [http://developer.mozilla.org/en/docs/nsICache nsICache]
* [http://developer.mozilla.org/en/docs/nsICacheEntryDescriptor nsICacheEntryDescriptor]
* [http://developer.mozilla.org/en/docs/nsICacheMetaDataVisitor nsICacheMetaDataVisitor]
* [http://developer.mozilla.org/en/docs/nsICacheListener nsICacheListener]
* [http://developer.mozilla.org/en/docs/nsICacheService nsICacheService]
* [http://developer.mozilla.org/en/docs/nsICacheSession nsICacheSession]
* [http://developer.mozilla.org/en/docs/nsICacheVisitor nsICacheVisitor]
* [http://developer.mozilla.org/en/docs/nsICacheDeviceInfo nsICacheDeviceInfo]
* [http://developer.mozilla.org/en/docs/nsICacheEntryInfo nsICacheEntryInfo]
* [http://developer.mozilla.org/en/docs/nsICachingChannel nsICachingChannel]
* [http://developer.mozilla.org/en/docs/nsIAccessible nsIAccessible]
* [http://developer.mozilla.org/en/docs/nsIAccessibleDocument nsIAccessibleDocument]
* [http://developer.mozilla.org/en/docs/nsIAccessibleEditableText nsIAccessibleEditableText]
* nsIAccessibilityService
* [http://developer.mozilla.org/en/docs/nsICookie nsICookie]
* [http://developer.mozilla.org/en/docs/nsICookie2 nsICookie2]
* [http://developer.mozilla.org/en/docs/nsICookieAcceptDialog: nsICookieAcceptDialog]
* [http://developer.mozilla.org/en/docs/nsICookieConsent nsICookieConsent]
* [http://developer.mozilla.org/en/docs/nsICookieManager nsICookieManager]
* [http://developer.mozilla.org/en/docs/nsICookieManager2 nsICookieManager2]
* [http://developer.mozilla.org/en/docs/nsICookiePermission nsICookiePermission]
* [http://developer.mozilla.org/en/docs/nsICookiePromptService nsICookiePromptService]
* [http://developer.mozilla.org/en/docs/nsICookieService nsICookieService]
* [http://developer.mozilla.org/en/docs/nsICookieStorage nsICookieStorage]
* [http://developer.mozilla.org/en/docs/nsIAccessibleHyperLink nsIAccessibleHyperLink]
* [http://developer.mozilla.org/en/docs/nsIAccessibleHyperText nsIAccessibleHyperText]
* [http://developer.mozilla.org/en/docs/nsIAccessibleProvider nsIAccessProvider]
* [http://developer.mozilla.org/en/docs/nsIAppShell nsIAppShell]
* [http://developer.mozilla.org/en/docs/nsIAppShellService nsIAppShellService]
* [http://developer.mozilla.org/en/docs/nsIArray nsIArray]
* [http://developer.mozilla.org/en/docs/nsICancelable nsICancelable]
 
 
Interfaces not found:
 
* nsIAccessibleAction
* nsIAccessibleCaret
* nsIAccessibleEventListener
 
Basically, the first thing that needs to be done is to start reading about these interfaces because they are from different API's and they have different standards and requirements.
 
After that I will start documenting these IDL's into the [http://developer.mozilla.org/en/docs/Interfaces MDC - Interfaces Documentation] section.
== Project News ==

Navigation menu