diff options
author | Mårten Nordheim <marten.nordheim@qt.io> | 2023-06-20 16:07:33 +0200 |
---|---|---|
committer | Mårten Nordheim <marten.nordheim@qt.io> | 2023-08-17 13:15:00 +0000 |
commit | 5be45ff6a6e157d45b0010a4f09d3a11e62fddce (patch) | |
tree | 0f620033b6059a2b23dab1f2af7aed56b10d0af5 /examples/network/doc | |
parent | 50bce440277d4383dcf3a055cb9b5d513735bcbc (diff) |
Multi-stream* example: add simple docs
To make it show up in the documentation.
It's also our only example showing SCTP.
Change-Id: Ib80ab869d9a6cbd370aa1a0c74772639e4393b37
Reviewed-by: Timur Pocheptsov <timur.pocheptsov@qt.io>
Diffstat (limited to 'examples/network/doc')
-rw-r--r-- | examples/network/doc/images/multi-stream-client-example.webp | bin | 0 -> 27060 bytes | |||
-rw-r--r-- | examples/network/doc/images/multi-stream-server-example.webp | bin | 0 -> 19164 bytes | |||
-rw-r--r-- | examples/network/doc/src/multistreamclient.qdoc | 15 | ||||
-rw-r--r-- | examples/network/doc/src/multistreamserver.qdoc | 16 |
4 files changed, 31 insertions, 0 deletions
diff --git a/examples/network/doc/images/multi-stream-client-example.webp b/examples/network/doc/images/multi-stream-client-example.webp Binary files differnew file mode 100644 index 0000000000..6ec651ae9e --- /dev/null +++ b/examples/network/doc/images/multi-stream-client-example.webp diff --git a/examples/network/doc/images/multi-stream-server-example.webp b/examples/network/doc/images/multi-stream-server-example.webp Binary files differnew file mode 100644 index 0000000000..95610e7267 --- /dev/null +++ b/examples/network/doc/images/multi-stream-server-example.webp diff --git a/examples/network/doc/src/multistreamclient.qdoc b/examples/network/doc/src/multistreamclient.qdoc new file mode 100644 index 0000000000..bf7ecb802a --- /dev/null +++ b/examples/network/doc/src/multistreamclient.qdoc @@ -0,0 +1,15 @@ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only + +/*! + \example multistreamclient + \title Multi-stream Client + \examplecategory {Networking} + \meta tags {network,sctp} + \ingroup examples-network + \brief Demonstrates how to use SCTP on the client side + + This example demonstrates how to use SCTP, with multiple channels, + to interact with other clients through a server. + \image multi-stream-client-example.webp +*/ diff --git a/examples/network/doc/src/multistreamserver.qdoc b/examples/network/doc/src/multistreamserver.qdoc new file mode 100644 index 0000000000..3601d0ddad --- /dev/null +++ b/examples/network/doc/src/multistreamserver.qdoc @@ -0,0 +1,16 @@ +// Copyright (C) 2016 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only + +/*! + \example multistreamserver + \title Multi-stream Server + \examplecategory {Networking} + \meta tags {network,sctp} + \ingroup examples-network + \brief Demonstrates how to use SCTP on the server side + + This example demonstrates how to use SCTP, with multiple channels, + on the server side, receiving multiple connections and sending + messages to connected clients. + \image multi-stream-server-example.webp +*/ |