Skip to content
Projects
Groups
Snippets
Help
Loading...
Help
Support
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in / Register
Toggle navigation
C
converse.js
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
0
Issues
0
List
Boards
Labels
Milestones
Merge Requests
0
Merge Requests
0
Analytics
Analytics
Repository
Value Stream
Wiki
Wiki
Snippets
Snippets
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Commits
Issue Boards
Open sidebar
nexedi
converse.js
Commits
16deecd4
Commit
16deecd4
authored
Sep 02, 2018
by
JC Brand
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
All API methods of converse-core are now documented with jsdoc
parent
45fc71c0
Changes
3
Expand all
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
323 additions
and
23 deletions
+323
-23
docs/source/developer_api.rst
docs/source/developer_api.rst
+3
-3
docs/source/jsdoc_intro.md
docs/source/jsdoc_intro.md
+4
-4
src/converse-core.js
src/converse-core.js
+316
-16
No files found.
docs/source/developer_api.rst
View file @
16deecd4
...
...
@@ -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
...
...
docs/source/jsdoc_intro.md
View file @
16deecd4
...
...
@@ -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
Grouping
s
## API
Namespace
s
The Converse API is often broken up into different logical "
grouping
s" (for
The Converse API is often broken up into different logical "
namespace
s" (for
example
`converse.plugins`
or
`converse.contacts`
).
There are some exceptions to this, like
`converse.initialize`
, which aren't
grouping
s but single methods.
namespace
s but single methods.
The
grouping
s logically group methods, such as standardised accessors and
The
namespace
s logically group methods, such as standardised accessors and
mutators:
*
.get
...
...
src/converse-core.js
View file @
16deecd4
This diff is collapsed.
Click to expand it.
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment