Commit 16deecd4 authored by JC Brand's avatar JC Brand

All API methods of converse-core are now documented with jsdoc

parent 45fc71c0
......@@ -572,7 +572,7 @@ This grouping collects API functions related to the current logged in user.
jid
~~~
Return's the current user's full JID (Jabber ID).
Returns the current user's full JID (Jabber ID).
.. code-block:: javascript
......@@ -907,7 +907,7 @@ To return an array of views, provide an array of JIDs:
The **listen** grouping
-----------------------
Converse emits events to which you can subscribe from your own JavaScript.
Converse emits events to which you can subscribe to.
Concerning events, the following methods are available under the "listen"
grouping:
......@@ -1201,7 +1201,7 @@ For example:
get(key)
~~~~~~~~
Returns the value of a configuration settings. For example:
Returns the value of the particular configuration setting. For example:
.. code-block:: javascript
......
......@@ -21,15 +21,15 @@ Inside a plugin, you can get access to the `_converse.api` object. Note the
underscore in front of `_converse`, which indicates that this is a private,
closured object.
## API Groupings
## API Namespaces
The Converse API is often broken up into different logical "groupings" (for
The Converse API is often broken up into different logical "namespaces" (for
example `converse.plugins` or `converse.contacts`).
There are some exceptions to this, like `converse.initialize`, which aren't
groupings but single methods.
namespaces but single methods.
The groupings logically group methods, such as standardised accessors and
The namespaces logically group methods, such as standardised accessors and
mutators:
* .get
......
This diff is collapsed.
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment