823740 - Updates to low-level API documentation

Status: RESOLVED FIXED

(Add-on SDK Graveyard :: Documentation, defect, P2)

Description

[Will Bamberg [:wbamberg]]

Attachment: pointer to pull request

This includes a number of updates to low-level API documentation:

* removed content-proxy.md
* removed obsolete or misleading wording (references to e10s, or "This module is not intended to be used directly by programs")
* made sure deprecated modules point people at the replacements, where they exist
* added basic documentation for tabs/utils
* changed various modules to use the <api></api> syntax, so they are formatted consistently and get tables of contents
* changed the text contents of tables of contents, to not include datatypes or arguments. This makes them less likely to wrap and therefore (I think) easier to read.
* some spelling, grammar, and formatting fixes
* changed the way module H1 and titles are generated, so multi-part modules get called (for example) "tabs/utils", not just "utils"

There's still room for improvement, and especially better examples, but this gives all the modules at least some useful documentation, except loader/cuddlefish, test/harness and test/runner, which will need to wait for another time.

Comment 1

[[github robot]]

Commit pushed to master at https://github.com/mozilla/addon-sdk

https://github.com/mozilla/addon-sdk/commit/61835812eb8ab8dee7c9bacb02e208e9829942d7
Merge pull request #699 from wbamberg/llapi-cleanup

Fix for bug 823740.

Comment 2

[[github robot]]

Commit pushed to integration at https://github.com/mozilla/addon-sdk

https://github.com/mozilla/addon-sdk/commit/61835812eb8ab8dee7c9bacb02e208e9829942d7
Merge pull request #699 from wbamberg/llapi-cleanup

Comment 3

[[github robot]]

Commit pushed to stabilization at https://github.com/mozilla/addon-sdk

https://github.com/mozilla/addon-sdk/commit/4e8ee77af9a2052e5f3ea457cb56798967f89ef8
Merge pull request #699 from wbamberg/llapi-cleanup

Fix for bug 823740.(cherry picked from commit 61835812eb8ab8dee7c9bacb02e208e9829942d7)

Comment 5

[[github robot]]

Commit pushed to release at https://github.com/mozilla/addon-sdk

https://github.com/mozilla/addon-sdk/commit/4e8ee77af9a2052e5f3ea457cb56798967f89ef8
Merge pull request #699 from wbamberg/llapi-cleanup

Comment 6

[[github robot]]

Commit pushed to stabilization at https://github.com/mozilla/addon-sdk

https://github.com/mozilla/addon-sdk/commit/61835812eb8ab8dee7c9bacb02e208e9829942d7
Merge pull request #699 from wbamberg/llapi-cleanup