Skip to content

Commit 1f6c678

Browse files
committed
Updated API docs
1 parent 852a72b commit 1f6c678

File tree

3 files changed

+12
-5
lines changed

3 files changed

+12
-5
lines changed

api-docs-gen/README.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,18 @@
11
# Navigating through the API docs
22

3+
These docs correspond to NPM released main line versions.
4+
Please see [dev docs](../develop/) for development versions.
5+
36
The API docs cover three libraries:
47

58
- @stomp/stompjs
69
- @stomp/rx-stomp - builds over @stomp/stompjs
710
- @stomp/ng2-stompjs - thin wrapper over @stomp/rx-stomp
811

912
The documentation for classes indicate which library each of the classes
10-
belong. See the [guides](/) for more information.
13+
belong. See the [guides](/) for more information and tutorials.
14+
15+
These documents have been generated using [Compodoc](https://compodoc.app/).
1116

1217
## stompjs
1318

@@ -34,4 +39,3 @@ Deprecated classes:
3439

3540
- [StompRService](./injectables/StompRService.html)
3641
- [StompService](./injectables/StompService.html)
37-

api-docs/latest/index.html

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,14 +32,17 @@
3232
<div class="content-data">
3333

3434
<h1 id="navigating-through-the-api-docs">Navigating through the API docs</h1>
35+
<p>These docs correspond to NPM released main line versions.
36+
Please see <a href="../develop/">dev docs</a> for development versions.</p>
3537
<p>The API docs cover three libraries:</p>
3638
<ul>
3739
<li>@stomp/stompjs</li>
3840
<li>@stomp/rx-stomp - builds over @stomp/stompjs</li>
3941
<li>@stomp/ng2-stompjs - thin wrapper over @stomp/rx-stomp</li>
4042
</ul>
4143
<p>The documentation for classes indicate which library each of the classes
42-
belong. See the <a href="/">guides</a> for more information.</p>
44+
belong. See the <a href="/">guides</a> for more information and tutorials.</p>
45+
<p>These documents have been generated using <a href="https://compodoc.app/">Compodoc</a>.</p>
4346
<h2 id="stompjs">stompjs</h2>
4447
<p>Preferred entry point is <a href="./classes/Client.html">Client</a>.
4548
If you are using compatibility mode your entry point would be

api-docs/latest/js/search/search_index.js

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)