summaryrefslogtreecommitdiffstats
path: root/examples/network/networkprotocol/networkprotocol.doc
diff options
context:
space:
mode:
Diffstat (limited to 'examples/network/networkprotocol/networkprotocol.doc')
-rw-r--r--examples/network/networkprotocol/networkprotocol.doc26
1 files changed, 26 insertions, 0 deletions
diff --git a/examples/network/networkprotocol/networkprotocol.doc b/examples/network/networkprotocol/networkprotocol.doc
new file mode 100644
index 0000000..ea00797
--- /dev/null
+++ b/examples/network/networkprotocol/networkprotocol.doc
@@ -0,0 +1,26 @@
+/*
+*/
+
+/*! \page networkprotocol-example.html
+
+ \ingroup network-examples
+
+ \title A simple NNTP implementation
+
+ This example shows how to implement your own QNetworkProtocol. The
+ protocol that was chosen for this example is NTTP. Please note that this
+ implementation is very simple since it is designed to be an example. It
+ should not be used as a real NNTP implemention.
+
+ <hr>
+
+ Header file (nntp.h):
+
+ \include network/networkprotocol/nntp.h
+
+ <hr>
+
+ Implementation (nntp.cpp):
+
+ \include network/networkprotocol/nntp.cpp
+*/