Difference between revisions of "Documenting Interface Reference Documents"

From CDOT Wiki
Jump to: navigation, search
(→‎Release 0.2)
(Grammar fixes)
 
(14 intermediate revisions by 2 users not shown)
Line 3: Line 3:
  
 
== Project Description ==
 
== 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".  
+
Mozilla is comprised of many interfaces that are used for programming the core as well as for writing add-ons. A majority of these are currently undocumented. This project will seek to document as many interfaces, and interfaces of value to the upcoming Firefox 3 release, as possible.
  
−
(See: http://developer.mozilla.org/en/docs/MDC:Writing_interface_reference_documentation)
+
Reference: http://developer.mozilla.org/en/docs/MDC:Writing_interface_reference_documentation
  
 
== Project Leader ==
 
== Project Leader ==
Line 11: Line 11:
  
 
== Project Contributor(s) ==
 
== Project Contributor(s) ==
 +
* [[User:vbala|Vijey Balasundaram]]
 +
* [[User:ayhfung|Andrew Fung]]
 +
* [[User:kglee|Kenneth Lee]]
  
 
== Project Details ==
 
== Project Details ==
Line 27: Line 30:
  
 
===      Release 0.2 ===
 
===      Release 0.2 ===
−
'''Goals: Document the following Storage API Interfaces'''
+
'''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.org/en/docs/nsILivemarkService nsILivemarkService]
 +
* [http://developer.mozilla.org/en/docs/nsINavBookmarksService nsINavBookmarksService]
 +
* [http://developer.mozilla.org/en/docs/nsINavHistoryService nsINavHistoryService]
 +
* [http://developer.mozilla.org/en/docs/nsITaggingService nsITaggingService]
 +
* [http://developer.mozilla.org/en/docs/nsIAnnotationObserver nsIAnnotationObserver]
 +
* [http://developer.mozilla.org/en/docs/nsINavBookmarkObserver nsINavBookmarkObserver]
 +
* [http://developer.mozilla.org/en/docs/nsINavHistoryQuery nsINavHistoryQuery]
 +
* [http://developer.mozilla.org/en/docs/nsINavHistoryQueryOptions nsINavHistoryQueryOptions]
 +
 
 +
Basically, the first thing that needs to be done is to start reading about the [http://developer.mozilla.org/en/docs/Places Places API]. Then read into the Places API IDL files that contain information about Firefox's bookmarks and history system.
  
−
Currently, i don't have a list of API Interfaces that i need to document, i am still waiting for that list from my contact at Mozilla (Eric Shepherd).
+
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 ===
 
===      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 ==
 
== Project News ==

Latest revision as of 13:44, 15 December 2007

Project Name

Documenting Interface Reference Documents

Project Description

Mozilla is comprised of many interfaces that are used for programming the core as well as for writing add-ons. A majority of these are currently undocumented. This project will seek to document as many interfaces, and interfaces of value to the upcoming Firefox 3 release, as possible.

Reference: 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

Basically, the first thing that needs to be done is to start reading about the Places API. Then read into the Places API IDL files that contain information about Firefox's bookmarks and history system.

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

Release 0.3

Goals: Document the following Public Places Interfaces


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 MDC - Interfaces Documentation section.

Project News

Retrieved from "https://wiki.cdot.senecapolytechnic.ca/w/index.php?title=Documenting_Interface_Reference_Documents&oldid=14069"