diff options
Diffstat (limited to 'tools/addon-sdk-1.12/python-lib/cuddlefish/tests/static-files/doc/module-source')
7 files changed, 92 insertions, 0 deletions
diff --git a/tools/addon-sdk-1.12/python-lib/cuddlefish/tests/static-files/doc/module-source/high-level-modules.md b/tools/addon-sdk-1.12/python-lib/cuddlefish/tests/static-files/doc/module-source/high-level-modules.md new file mode 100644 index 0000000..8745e13 --- /dev/null +++ b/tools/addon-sdk-1.12/python-lib/cuddlefish/tests/static-files/doc/module-source/high-level-modules.md @@ -0,0 +1,18 @@ +<!-- This Source Code Form is subject to the terms of the Mozilla Public + - License, v. 2.0. If a copy of the MPL was not distributed with this + - file, You can obtain one at http://mozilla.org/MPL/2.0/. --> + +# High-Level APIs # + +Modules in this section implement high-level APIs for +building add-ons: + +* creating user interfaces +* interacting with the web +* interacting with the browser + +Unless the documentation explicitly says otherwise, all these modules are +"supported": meaning that they are relatively stable, and that we'll avoid +making incompatible changes to them unless absolutely necessary. + +<ul id="module-index"></ul> diff --git a/tools/addon-sdk-1.12/python-lib/cuddlefish/tests/static-files/doc/module-source/low-level-modules.md b/tools/addon-sdk-1.12/python-lib/cuddlefish/tests/static-files/doc/module-source/low-level-modules.md new file mode 100644 index 0000000..bc44007 --- /dev/null +++ b/tools/addon-sdk-1.12/python-lib/cuddlefish/tests/static-files/doc/module-source/low-level-modules.md @@ -0,0 +1,36 @@ +<!-- This Source Code Form is subject to the terms of the Mozilla Public + - License, v. 2.0. If a copy of the MPL was not distributed with this + - file, You can obtain one at http://mozilla.org/MPL/2.0/. --> + +# Low-Level APIs # + +Modules in this section implement low-level APIs. These +modules fall roughly into three categories: + +* fundamental utilities such as +[collection](modules/sdk/util/collection.html) and +[url](modules/sdk/url.html). Many add-ons are likely to +want to use modules from this category. + +* building blocks for higher level modules, such as +[events](modules/sdk/events/core.html), +[worker](modules/sdk/content/worker.html), and +[api-utils](modules/sdk/deprecated/api-utils.html). You're more +likely to use these if you are building your own modules that +implement new APIs, thus extending the SDK itself. + +* privileged modules that expose powerful low-level capabilities +such as [window/utils](modules/sdk/window/utils.html) and +[xhr](modules/sdk/net/xhr.html). You can use these +modules in your add-on if you need to, but should be aware that +the cost of privileged access is the need to take more elaborate +security precautions. In many cases these modules have simpler, +more restricted analogs among the "High-Level APIs" (for +example, [windows](modules/sdk/windows.html) or +[request](modules/sdk/request.html)). + +These modules are still in active development, and we expect to +make incompatible changes to them in future releases. + + +<ul id="module-index"></ul> diff --git a/tools/addon-sdk-1.12/python-lib/cuddlefish/tests/static-files/doc/module-source/sdk/aardvark-feeder.md b/tools/addon-sdk-1.12/python-lib/cuddlefish/tests/static-files/doc/module-source/sdk/aardvark-feeder.md new file mode 100644 index 0000000..3845955 --- /dev/null +++ b/tools/addon-sdk-1.12/python-lib/cuddlefish/tests/static-files/doc/module-source/sdk/aardvark-feeder.md @@ -0,0 +1,12 @@ +<!-- This Source Code Form is subject to the terms of the Mozilla Public + - License, v. 2.0. If a copy of the MPL was not distributed with this + - file, You can obtain one at http://mozilla.org/MPL/2.0/. --> + +The `aardvark-feeder` module simplifies feeding aardvarks. + +<api name="feed"> +@function + Feed the aardvark. +@param food {string} + The food. Aardvarks will eat anything. +</api> diff --git a/tools/addon-sdk-1.12/python-lib/cuddlefish/tests/static-files/doc/module-source/sdk/anteater/anteater.md b/tools/addon-sdk-1.12/python-lib/cuddlefish/tests/static-files/doc/module-source/sdk/anteater/anteater.md new file mode 100644 index 0000000..c480ce3 --- /dev/null +++ b/tools/addon-sdk-1.12/python-lib/cuddlefish/tests/static-files/doc/module-source/sdk/anteater/anteater.md @@ -0,0 +1,10 @@ +<!-- This Source Code Form is subject to the terms of the Mozilla Public + - License, v. 2.0. If a copy of the MPL was not distributed with this + - file, You can obtain one at http://mozilla.org/MPL/2.0/. --> + +The `anteater` module should not be used by anyone. + +<api name="release"> +@function + Releases the anteater. Do not call this function. +</api> diff --git a/tools/addon-sdk-1.12/python-lib/cuddlefish/tests/static-files/doc/module-source/sdk/main.md b/tools/addon-sdk-1.12/python-lib/cuddlefish/tests/static-files/doc/module-source/sdk/main.md new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/tools/addon-sdk-1.12/python-lib/cuddlefish/tests/static-files/doc/module-source/sdk/main.md diff --git a/tools/addon-sdk-1.12/python-lib/cuddlefish/tests/static-files/doc/module-source/sdk/not_a_doc.js b/tools/addon-sdk-1.12/python-lib/cuddlefish/tests/static-files/doc/module-source/sdk/not_a_doc.js new file mode 100644 index 0000000..f4abc3b --- /dev/null +++ b/tools/addon-sdk-1.12/python-lib/cuddlefish/tests/static-files/doc/module-source/sdk/not_a_doc.js @@ -0,0 +1,5 @@ +# This Source Code Form is subject to the terms of the Mozilla Public +# License, v. 2.0. If a copy of the MPL was not distributed with this +# file, You can obtain one at http://mozilla.org/MPL/2.0/. + +not a doc
\ No newline at end of file diff --git a/tools/addon-sdk-1.12/python-lib/cuddlefish/tests/static-files/doc/module-source/third-party-modules.md b/tools/addon-sdk-1.12/python-lib/cuddlefish/tests/static-files/doc/module-source/third-party-modules.md new file mode 100644 index 0000000..33e957c --- /dev/null +++ b/tools/addon-sdk-1.12/python-lib/cuddlefish/tests/static-files/doc/module-source/third-party-modules.md @@ -0,0 +1,11 @@ +<!-- This Source Code Form is subject to the terms of the Mozilla Public + - License, v. 2.0. If a copy of the MPL was not distributed with this + - file, You can obtain one at http://mozilla.org/MPL/2.0/. --> + +# Third-party APIs # + +This section include modules you've added to the SDK. The tutorial on +[adding menu items to Firefox](dev-guide/tutorials/adding-menus.html) +explains how to add third-party modules to your SDK installation. + +<ul id="module-index"></ul> |