From 0f8b7deef1e6d2b0d24f83c12c3ce11ed0fc0640 Mon Sep 17 00:00:00 2001 From: Eskil Abrahamsen Blomfeldt Date: Tue, 4 Dec 2012 14:06:35 +0100 Subject: [PATCH] Move Network Examples from qtdoc to qtbase Move the main example overview and use the \group tag convention to make the list update automatically. Change-Id: Ib2cc8cf7def9a7f3dce6b7ed6d4958771cbdf5cd Reviewed-by: Jerome Pasion Reviewed-by: Paul Olav Tvete --- .../doc/src/blockingfortuneclient.qdoc | 1 + .../network/doc/src/broadcastreceiver.qdoc | 1 + examples/network/doc/src/broadcastsender.qdoc | 1 + examples/network/doc/src/fortuneclient.qdoc | 1 + examples/network/doc/src/fortuneserver.qdoc | 1 + examples/network/doc/src/googlesuggest.qdoc | 1 + examples/network/doc/src/http.qdoc | 1 + examples/network/doc/src/loopback.qdoc | 1 + .../network/doc/src/multicastreceiver.qdoc | 1 + examples/network/doc/src/multicastsender.qdoc | 1 + examples/network/doc/src/network-chat.qdoc | 1 + .../network/doc/src/securesocketclient.qdoc | 1 + .../doc/src/threadedfortuneserver.qdoc | 1 + examples/network/doc/src/torrent.qdoc | 1 + src/network/doc/images/network-examples.png | Bin 0 -> 8946 bytes src/network/doc/src/examples.qdoc | 68 ++++++++++++++++++ 16 files changed, 82 insertions(+) create mode 100644 src/network/doc/images/network-examples.png create mode 100644 src/network/doc/src/examples.qdoc diff --git a/examples/network/doc/src/blockingfortuneclient.qdoc b/examples/network/doc/src/blockingfortuneclient.qdoc index 581cbe66993..4e105b50a75 100644 --- a/examples/network/doc/src/blockingfortuneclient.qdoc +++ b/examples/network/doc/src/blockingfortuneclient.qdoc @@ -28,6 +28,7 @@ /*! \example blockingfortuneclient \title Blocking Fortune Client Example + \ingroup examples-network \brief The Blocking Fortune Client example shows how to create a client for a network service using QTcpSocket's synchronous API in a non-GUI thread. diff --git a/examples/network/doc/src/broadcastreceiver.qdoc b/examples/network/doc/src/broadcastreceiver.qdoc index 99a4cd38235..374bc29244c 100644 --- a/examples/network/doc/src/broadcastreceiver.qdoc +++ b/examples/network/doc/src/broadcastreceiver.qdoc @@ -28,6 +28,7 @@ /*! \example broadcastreceiver \title Broadcast Receiver Example + \ingroup examples-network \brief The Broadcast Receiver example shows how to receive information that is broadcasted over a local network. diff --git a/examples/network/doc/src/broadcastsender.qdoc b/examples/network/doc/src/broadcastsender.qdoc index dc916e3fedf..a587c5fddd3 100644 --- a/examples/network/doc/src/broadcastsender.qdoc +++ b/examples/network/doc/src/broadcastsender.qdoc @@ -28,6 +28,7 @@ /*! \example broadcastsender \title Broadcast Sender Example + \ingroup examples-network \brief The Broadcast Sender example shows how to broadcast information to multiple clients on a local network. diff --git a/examples/network/doc/src/fortuneclient.qdoc b/examples/network/doc/src/fortuneclient.qdoc index 6ef9155337c..f7a4c560201 100644 --- a/examples/network/doc/src/fortuneclient.qdoc +++ b/examples/network/doc/src/fortuneclient.qdoc @@ -28,6 +28,7 @@ /*! \example fortuneclient \title Fortune Client Example + \ingroup examples-network \brief The Fortune Client example shows how to create a client for a simple network service using QTcpSocket. It is intended to be run alongside the diff --git a/examples/network/doc/src/fortuneserver.qdoc b/examples/network/doc/src/fortuneserver.qdoc index 05e96b4dede..d702bc6bb11 100644 --- a/examples/network/doc/src/fortuneserver.qdoc +++ b/examples/network/doc/src/fortuneserver.qdoc @@ -28,6 +28,7 @@ /*! \example fortuneserver \title Fortune Server Example + \ingroup examples-network \brief The Fortune Server example shows how to create a server for a simple network service. It is intended to be run alongside the diff --git a/examples/network/doc/src/googlesuggest.qdoc b/examples/network/doc/src/googlesuggest.qdoc index ff16cbf9e08..c04e65c3f9d 100644 --- a/examples/network/doc/src/googlesuggest.qdoc +++ b/examples/network/doc/src/googlesuggest.qdoc @@ -28,6 +28,7 @@ /*! \example googlesuggest \title Google Suggest Example + \ingroup examples-network \brief The Google Suggest example demonstrates how to use the QNetworkAccessManager class to obtain a list of suggestions from the Google search engine as the diff --git a/examples/network/doc/src/http.qdoc b/examples/network/doc/src/http.qdoc index 67bdbdb558d..89223b78949 100644 --- a/examples/network/doc/src/http.qdoc +++ b/examples/network/doc/src/http.qdoc @@ -28,6 +28,7 @@ /*! \example http \title HTTP Example + \ingroup examples-network \brief The HTTP example demonstrates a simple HTTP client that shows how to fetch files specified by URLs from remote hosts. diff --git a/examples/network/doc/src/loopback.qdoc b/examples/network/doc/src/loopback.qdoc index 52518a00281..e278a9e9bd3 100644 --- a/examples/network/doc/src/loopback.qdoc +++ b/examples/network/doc/src/loopback.qdoc @@ -28,6 +28,7 @@ /*! \example loopback \title Loopback Example + \ingroup examples-network \brief The Loopback example shows how to communicate between simple clients and servers on a local host. diff --git a/examples/network/doc/src/multicastreceiver.qdoc b/examples/network/doc/src/multicastreceiver.qdoc index fddbafe788b..88ed6020d41 100644 --- a/examples/network/doc/src/multicastreceiver.qdoc +++ b/examples/network/doc/src/multicastreceiver.qdoc @@ -28,6 +28,7 @@ /*! \example multicastreceiver \title Multicast Receiver Example + \ingroup examples-network \brief The Multicast Receiever example shows how to receive information that is sent to a multicast group. diff --git a/examples/network/doc/src/multicastsender.qdoc b/examples/network/doc/src/multicastsender.qdoc index 8d8a4007691..4ec9defb531 100644 --- a/examples/network/doc/src/multicastsender.qdoc +++ b/examples/network/doc/src/multicastsender.qdoc @@ -28,6 +28,7 @@ /*! \example multicastsender \title Multicast Sender Example + \ingroup examples-network \brief The Multicast Sender example shows how to send information to multiple clients in a multicast group. diff --git a/examples/network/doc/src/network-chat.qdoc b/examples/network/doc/src/network-chat.qdoc index 0430b5219da..cd5ec4b348c 100644 --- a/examples/network/doc/src/network-chat.qdoc +++ b/examples/network/doc/src/network-chat.qdoc @@ -28,6 +28,7 @@ /*! \example network-chat \title Network Chat Example + \ingroup examples-network \brief The Network Chat example demonstrates a stateful peer-to-peer Chat client that uses broadcasting with QUdpSocket and QNetworkInterface to discover diff --git a/examples/network/doc/src/securesocketclient.qdoc b/examples/network/doc/src/securesocketclient.qdoc index 16986292af5..a61a00e8339 100644 --- a/examples/network/doc/src/securesocketclient.qdoc +++ b/examples/network/doc/src/securesocketclient.qdoc @@ -28,6 +28,7 @@ /*! \example securesocketclient \title Secure Socket Client Example + \ingroup examples-network \brief The Secure Socket Client example shows how to use QSslSocket to communicate over an encrypted (SSL) connection. It also demonstrates how diff --git a/examples/network/doc/src/threadedfortuneserver.qdoc b/examples/network/doc/src/threadedfortuneserver.qdoc index f8441bcc2f5..43a7e882416 100644 --- a/examples/network/doc/src/threadedfortuneserver.qdoc +++ b/examples/network/doc/src/threadedfortuneserver.qdoc @@ -28,6 +28,7 @@ /*! \example threadedfortuneserver \title Threaded Fortune Server Example + \ingroup examples-network \brief The Threaded Fortune Server example shows how to create a server for a simple network service that uses threads to handle requests from different diff --git a/examples/network/doc/src/torrent.qdoc b/examples/network/doc/src/torrent.qdoc index ef13ef6ed99..791464c9a49 100644 --- a/examples/network/doc/src/torrent.qdoc +++ b/examples/network/doc/src/torrent.qdoc @@ -28,6 +28,7 @@ /*! \example torrent \title Torrent Example + \ingroup examples-network \brief The Torrent example is a functional BitTorrent client that illustrates how to write a complex TCP/IP application using Qt. diff --git a/src/network/doc/images/network-examples.png b/src/network/doc/images/network-examples.png new file mode 100644 index 0000000000000000000000000000000000000000..15dfba850a07c71739cd5bd5fbac220c0098bdaf GIT binary patch literal 8946 zcmVFP00009a7bBm000Y# z000Y#0XNCZtpETbq)9|URCwC$o%vf-SDMH34@~#WA29RG4>Qlqq$iWabdv5Q-O(gE z=}Z!hBZ)?hYur#)QNdjh6=in=WRo3AwxSk_Vyj}`3n=z|6Wle?q`T93<|9|{Tnk00 zR4K?k&l_^GX`TzNwi^>-gfNBz|a1P`6mqGomXz*%%U~@(xOiN-1>quh<;a zD{bn zll+A{w8FIoedw6G$mxF3d&^IK=92lj%l#WaaZDy>!8V;m`yV(O|JSRSqK~&G{>L9T zy*z)*r%nofF5Z>@p;I{(fbXT3=exYVQVsoKo%-ZCewlsBKb@WyV zr2<_ZyS06n-!{+i*Or{#=v{U(Rrhay3ho)a;p*k@@a>6zU2x#l<(Y1$3{JlK_t&NF z^iA_Tmh{Ij{pLBuxt-Ae&&CK!rLDaH^v?RsWqV5mdUcV<=dNnu`rY-Jf7qBM7D?%M zYct;8bie5L4t_$;$6HetZA#$ct#8sTAMthO=R5N$TI`-LKbB*S`wP~BYVj~lCgD$8K_$$H^@{ga* zW=34NI_Qm6nbOu?0Q%jUOG`Y8pwC=&OiRKwME*N#)45o%Hu|4lUHXsz^~FEW`*Pu? z6ms5Led*nG_lth-5b*ZW6VSX*4}SD*5;?zJrLbs!-m1($Iq4|+%?B=vHm5CE8}r(q z_VII}qxy~2N-78ty1u(v5549Q`%3!8clB$QSGvwKIxH!0ZtNO$KdBQ+1$x~f>~)6- z;rjO*RR6Uk_|4U+^S+FDZCMyO^S9|gbJM-^ZSL>a=e+S%)PmI^pKb_zbBWJe%K{Ds zWxTQM^gG{brLDaH^wuiHC(il@1=2Q>ck%~guuJ)!8gD-{;)zquy+ zqb=%38Xv!y|84f$>s3_v4G{ijf$IXNVv*J#(R-Xy?L4V+J)Yy_t6c1&kd{7;iq;>= zTXR7D;SN353w9K~zb*GucYSbN$uh@t@2pFiPE)gk-uPNEe`C%^TQpK4XWrL}c`MQu ze5Mw?qwS}{2pjAcbd#lkHE z0|QgJ<(HFAr+fYo8Vm-tTAe%dQeIx3@P@6et)`~dfuSptQ~%&tu1+u9($LV*+TQcj zTYfoVoPYih=H%quyLa#BnU{)+ibMz-8e94XMxoyEzY~f4-u}zrE<)JS)-`#3o8)V> z)8WF}+FFf9!?)Sn+dDKgWOE2>YHDa!+KGSr+us=OEqazw_q*@D>+9>ga^=dze*f!V z|4Na~A*?rxC zTU&K?wN|UGtgNJ?>+0&H`HWG`&CM1Nc64+&I5=$FxRL%UC@7#B_;q!4xw*MDH8oXL zRo%LEi*cVDFJ8Pzj=#VE)~#Cy2L~G)8;gsJfBf;s%an0yJ$rb!yLayb!%si` z#0v`*^m;wl%y1NmqEjcA+)u5G-l&Vzaj<^Yc4>`ZQ4O+_@8^U0q%G?b`>yM~)n!_xU#q`QWj4@80a}Y`We8 zLU@Z?+}+)o8bd-t&YnFBeq&=}`}gnn^75h)J{sERuaA$903nsBvu4d29>;8Y?AS5- zx~Hed#l=ObRH{@eVBnieNlBp^Z(debmYkd%6cj`w{H4Odg9l;gsX$m$*Vxw42Svxk z-MMoI>_PF)!xVclK`7Nc93IBG}R>h@kPp|!_&xCQkc=1yBm=>si=*ZEe zlyu>VIV$ZmAfzk1ySwQl*b5+c?b=131_uXIL?6Lhd&X1acshLeFbg>{*R5M8aE6e7 z=+Gh1nmCZs5di@K-rnA@GM`9XTpV}7NheR9@PMkOa1M%q`IB-CKkbFJ`UteGN zZ*+8&C;srm4_pTZ268XR0Ylz+q8;9oRU+?m^ypFkGG>^~W`MkX`}R~Itgbb+wDmwy z(HB`l^BSj4onk_H0AXzWcxks<0wGLBrn$A-$=QvI%xtyqv6ClH1?A=y0Rw0q_V)Gk zI>4wH5g8kPAx5Ri^V)lGkLNy3Zovt^09QAU22<-!k3GjuoPr&}TdOPByZ=yQQ+r_0 z>C9}6@IE;z%`_mSuZ0UxWHj5dWlLyiDA&TO5&-h^^8tw-g#Q@R7((gL)YMcem`o<} zv$C>;e7MR2LIyfMZSoTn6Jd8al_?Dt;U~?~p@0+~9?oD`UtbS*!cu%dbQGnG1iS`= z`T6tb$)O!)P+%tKFMs(B@fy_Rxl@6#s-}UN4~mS6r76H; z)S)&0;rxt=i4#gyYOM$%)2EPm_FTmNgNK7d&N75%WagBXRr?2q96oZCK{7fv;fT+% zVqx7d}kl`2`Nm=c5)m38$d)}^hwyrQ`HWD8Pj_2Z>2;;;sUHFZtGEp{cA$Il-^ z=Bk#Kmfjhb7?~OKMF`6)Y8VD5Cos!-IIIC7)8|uf`Q?$VX$jev&r!Su;5+P}SmntO%El%+ z%_0a@rOmE^sWLqu3P^SKPj)_)Bqf)C6hN5h>D7eh=@R&U5xDhryyh)_O zLN9dC!jmxWpsGgk2)Cip<^ru77bxM5A3u&VlL2Ar(xvE2F&Y4EOiT8TKc zS$k*S(xuBjU%UjPb9m~vo5H2N45upv+f`vX=w^5H+&6r&)j zXKV=AKqgT)%SnK6Wb|6->2n``v=9mm4(;w8%&-%L-+%u-LM|3sZs7uJ19k(!{w`b# z`8RLgWGdwXO+T#3j40zYIfMg4W3BDoQp(88wgy6M5$o1DtXcEFBCT4rSPG$>?2$@J zN;|sx@C1<3^dSsL75rJgn~-Dy!`=y1yPw}l3&I`38ZIPtcDB{l8r$2=lQ^C{HerAj zZs9N2@+x#%1L^JWezYJ>Zk{y|jw@FKMn^rnx=tZrFg3D5VdfJb1~ANRu%hoP44Aq4`JrCAq+^ByYe|g$jFJNTS}<8gRI~}^w$PMyuq;7V2H-d^y7Gv zJ`Ae`vczNGgBcOuSwZlyRq)E3g7E6~J5sXJQh_XZ=Z;b^Hkr-kCX-R4Nf8H9e15+8 z;tSN=EI5(*Sb`Gm0AOipX*hr*5#j@mfe8mMB4+TmK6maM7c5Y5#Ac-jS0gOoQKE(TMGdzJ9g}lp_&{*!O|;|T_8mH$wUZ# zOncams7yp4>QE$lph6D^oMa;Sv$93yMkeNa48qtB0a%7=5(vkw_BW+uy~%gy&Tm{@ zSBm85=pf65&j!NLD>tQNC4}(S#0Uhbnp;lxgYfd$4Jla(AqmXTip`J^vbh5xQpCvE z^#?S1pQaDtxM)8fUwLd~WJhbO56U*iRpv8MG-NKs(@=0UWobhWMa+Dtzscc(3P_e* zP%7kG)aNf1WIv3@LpXX}N&EiwAR|sBD#KI$E z5b?Eo^=fPvI6+~=U=<_8=_7|YIXN*Pqpm|~$94uXY!e{7J$(6^l&oLQOk$~!3Ka-{ zn068P;5=joA};v}V1#rt2opRFPKfj5fFD*T>LXp?aZ1FY4BrKxY47OjZR_Z^5<-T)*4EJadJmCQDlc0J6-=Cb0qnx?*lmI4ID|+M{ezbw zyb=2bMutYNSP3C}1-Va1Qipsw*$F}>zXlUK81*-s+gjVZ+SCq#63=4XmhlrHWaMPqjrPu- zrsh_r!&Ym!FyMi)>DI06TemVXHknK{wY3#0Ri9v8pUk^* z(36x4>l>QdI(nE3n_Jqgp9`k~A@VzXhNl|FCXi#>GlV}})?i9Z!Bhi6VdY6Fk_M&l z@up3iQ2oHZ;0H${{$rn#73d;_sAD?1`Ux&%Mbq6o)YUU!7YI?9;q1+f$Rm;MnDfAc z!4oD!A{1YUVG}8y;3jZohf6LH=Y`>vd|}sV8~_mTaVeJZd%%UmSC|Fi!j{%fa|@fK z^jZla=6GM|k8>(Z*Sgy`8z8xEYGj$*o_%J|iOos}qWE{A*;Ko(ADnVLxt> zfH3G6a^cV8TiQq=6od*EmWT?-=>((!7`NbPinPG;5+GTBvN~laZiGdgpfE0yDTj+r zK`sQseko0#3#R}fT!`cj9=I7Iwj;k|FJ!$#OcTzccx>SQdty8x`Qcy6?La7?F5~o6 z2$2h=WETkKWLNDBJ0?iU${jCIct%PROhz=X+{MoT!olGy?VY_+vJyfD!^%g~lY(I6 zWOE4F^hruqLdepwvQkr88d6b_J(Zmf%UsxJ`fU-U_sjAYKl7gMtXX>B}D3d9Q8a}&F1yH zpFq8~sBiC=e|-IHO&((?#Ue=xe*uikgEJa123ew z1Z7C-KZlo@Zhf0U*wiyN32}noBXs}2_K75%_4gPe+cxz(A6s95P(U#`Rq_AzAK&FF(}VX$uG+Zdy`XTUcHmRa28UyEeubArw$V-!Y3`o^6(F1|cfY(a|Krsz*l? zh1eIApXfrxhoN1-{6saJ@CmD6Lkn!e7?`jX&jbj09~{zMU0vB3d=_n&V@n9Z?AERL z(b3%^6%~0))!YQZPzT>bEKNk0u`>d_MkeN`=i3VeQXxz68U%8rq@>I)9jT2WoUmQO z0gGd|2yG!)iCbV(cE!hQ6sCOc5VCy=p;E*SurCAO7XFWO7sAQUY+_KQkND)V5fTB4 za}73qzItMprh7Drof4L3US@VNBD?q6LbQLly}ClNHz8rCNMT`HER0Rq3$fA9*zORv zznNWTOItz+M<+~3Y%3$1^kxl&B<|!xCP(hsSqUMlfa>ayrY4t~ngBxM@i8PE_pwhU zWM1z2nFt|5)xCQfVSDwVA>H6$uEB7g^^5p0+`S2+XCcFZudHa~-k)(0PQD^VcZ16s zO|z96vV`3AvkyWNXY+y|K;nTolh>tl62gbBz++?K{ry`+((CtI2o?B|GM38yZo`EC zCK7h>qltJ;Yn%|7-c~)DR<2x0e3RVEc1A9PqW*3Bf8B=lRPRiJrw@3!VQR!(hn3E|s=PytR5ONpD z!Fg~YvSUzC5H@63pTBb%LQa#YYiP2F@=Z-sOb=uWv*=-EUIoX)V5VL_mr8s>N|$`Th~5R-q>xdZ!fGiSGDw& zHgr;%{8CdV^(&fss?2@dTT0IIq2?L`Vni|9d zq;>A%XjrTkY-vfSBPMb?8UW5|LTnfEsepC{PaG_Z$QwxgG)QF{WG{V0L+-+oOlTPg zLh(2u;El#n(vr_+?fj)O$^`D^G+EjNX7S5VC=`4#XxrJApNAs(pa9}0H)21TTMz;p zVjmrf>V()c0K?3S*hj}9?a{v+X|R0xa+ryJL{t|bq(jla&|k>)7@oK$AFD4p)Zs5` z8lp-$6p#I)V`F2nCISW~VxZ-4Zax(DQlxQmfEMkK03n|OIY^(Bf<5`Xm=FZY_r#{t z!qf(Q^VqzE=MI za2{QQN|VlIG~DSN)dcaBXB>J84^+4!0`+W)M4NS4?Y@-Kn{)sQ3iap z=XeY7+3~O7ZGnw%i&vr%;fOYdmN~j2WnQ7nSWtiyJq{{1c@KJ@*;HO$%0h($O{W0i{7$|YKxQOY)+j0q1EP!_!&yd?EOSY zsmz%Z5aJQZ$+!K3V|Jy!fze!@UR3X4Rk!yOA&piyS0L=_9qR4BY**^(8`0+Gi4dAw zyX^f$NTZoE5HjY7rx@2anAI9xp1u&DK8pj6Cz7eD&D7ZXq|)lz#+J5j;kv75Nc)f{ zfDniIr#8-Et~sh)pQFdaBcfZ|d&GA1`G$(B`l=e!Q(I7La_0(!?VTL>Hz1I~Sl+<_ zjsqjg95v7u8_O5~OUtV(s_KdjWlhcP#*zx+P6`SQMa3m$6*Y}b&6U;lTI!TlHJLkd z^YV)grS!N?UznP9sk>WjxnCoJ5Z@N@iBBS9X_eRBgM0)DiK#&$XJTR#>Ka<&6H_B1 zWA`06eE5j(Q(I7}wQ~i+@zdh^1S%>nGq<#Hk)>4k4GeRB4RGQaT~Ju0QfUl^lFF*; z^o;D$(W^?Oy0*^LU~004413R@9Q7VQK^dzWqJC1y}qEjx;7;xwX>^7aVc};@|CQt9H0UX*sG+h zGBZ;N%=PuAv^0gerCpz2kfzA!?Cg2ia+g{HVMAk!_{1j>$a(EO0NZ){9D@-zY}^!j z=KO(!M_gRo!4JNCY75GoIRhd6%NQsSb75nX8Aj~w8zjH3p}E=I$~B$d(>qXaYVPSB ztgbbIERIVqy8sksIGx_bKS>KkdKuYX8vSsd0tu-;@A^Cuw& z@H1z_0WUYNP^HPsQS11g@(YbMbxm4b!BcO~R;uR;g#2q88r$qms)xfG5Z2Z=PxVGq zt4?n)mR4KwM8@{H0wHIsuu`x$kMiwfZ@ zANzo!l;%JB(`uS;qkNk@cfOrp^4aGD+