From 23a09278a2b8a4622c6c39ce0dccfbbbe4ce3901 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Simon=20St=C3=BCrz?= Date: Wed, 29 Oct 2014 13:04:24 +0100 Subject: [PATCH] changed style color and improved icon added GuhCore documentation for completeness --- doc/images/logo.png | Bin 6500 -> 5410 bytes doc/style.css | 2 +- libguh/devicemanager.cpp | 12 ++--- libguh/plugin/deviceplugin.cpp | 10 ++-- server/guhcore.cpp | 82 ++++++++++++++++++++++++++++++++- 5 files changed, 92 insertions(+), 14 deletions(-) diff --git a/doc/images/logo.png b/doc/images/logo.png index db5cf12036b80c3c133a6ab77e4ddaaecdb00659..bf9116e2c1343a32096fc3783f2ef6e8c53d6dec 100644 GIT binary patch literal 5410 zcmV+-72WEIP)dWOYFVaXCN&IRpsEgd}2Q&Z(}dTTB1${pz>fd#fIB00(dY z2e5Zz<{uZ103p?uV}FDyS15U_<$J4IW+pAn0idfEOkdM-h^_Gt02TzN-E`vQrB#q? zzeN`fv57B=NJ>O3P<}RR)#AgdA=v(kt|p5(C)gB0BgkJhuehr|QK|N0#0Y8r>w_sk zj*pg!$Wfj+4>dp7oJv--{Sz@l%+_rm2idRmBoUeD9n|#m<`qA#Nlvu=6EQ+^TGjz* zFL$CqzT`^&cherbry&u^_EW?Nxq1AgwNP>mNtQiZrcpR_hfq4#AJ33;xi&g+mJAUy?~rfRa!>uk+3h#Ut1AfO>2 z1OfsDZU}A{%5-PN+Iwfuo^7gCk$nZB$;q@yg8;UO)EL1dZYDj(v-GJ1*P!500>?rK zK!0B#gCJ;e$B$Tbz_+}AgoIe|1_j#!86-*`S02V@v#nns@v!gcr7S7_Me zr#*N}Z6dYUhY%9tC@E&*g%%c(0iyV@yJE!k&Z_mz9`qR`-i@3RBP9|m4;7KQwT=DX znz>@pwbP$#8Cda}>>~)B`m9xp#tGD_XsZ$cNYMYg)Oa$z3Zm89|5o#L`S!NB`5;`5rN1jq2#9n>uO$|xw2(S^NMD>Vzt`~5fWlM(jJo0 z#cuhKz*mSIZ@{PQ{NSH?lt*0XLqXmOvdzDw2U3E4kx@$IZY@oJpS7~(t0*&Awm%|l zgh|h}I73>oK!A%xBJphjBw!%OD+eOQ<`vQf@LMDD!?d_-J)JdYZrP%*iO3xSHu|Bj4cD>@ z7ndUih`R6+k_?0|3h04o6u}5UtR6^lL0);&_{j@F=t3rQILX!qH;*8v=%fCJcQD05abB7|Tu2 zwYvopCi-2&;=)=)gu?4*u4uU_dVI$6mhq0AdLG1CKoDma7m^Vl7x#sJ2ZM~WL{`sS z*|Ol8$A8*o9znGbBP7*eKT9$fx?MtnILjFG;*6yWZ^>(Jo;&fowJu+>jMKI3V~35 zfho#bj*q6g1`Mek;45qwEiCR^O35Mp8!p?uChT35jSjDSeBoSyO!xN)##<;{=Pd_W zCtdUzh=#tAyo96(WOu{jp3E0CsdEO12D{-k@%Z=CBmRXW`!|Y2OjKa5eA9(uxl-+$ zhHYp#R*tPo0$FxmRi-mL7s6(O@A%_WC=G`|0Je4^#zdZc2}9qQHWb3!auHatjo9sX z9)ZCU5d|=!9Weer!-$Gd6gJik4#|pY1j7B|5g{D=J-cf2n7hrN0AT8p`RQ6oe^J4F zo5ZOi;)Eup(6XLb=uG!3b~pk+A;KzV@}*kSI}sQ)sWZA*90{+2`wvX_euFe zVal1=T&~d=J&E8WAUgm61Z<;`a&rZ9E(LQg;eIqnL3F>2voGgkiW-I3dA{@lsEF@2 z08An0F#gg%RTtVi5#WWjFJnX77OdO85s$v~R2Pi_`Il;u0rWt~ZKq!T8j0g9s28R$ zS@3dAI(23vqR- zt~Qr}_mV~RHvq31$X&|l&U7|ATG!ScO-p?i#8?RILdOyOO8aYn(nHu&1)+f9F@#4M zo*P^R2>n5q$kh;AfzT|f7K{H51+NepkNM2uABQ2at+N%b_Tm~s(1LoPcbaz3(4!9l zfa$+qcmu%ZuprDyA}1Ag39YRAP|B7^{SIPf-IEfOiLJ!9 zjuA2nPQD|Xjf7x9kSqAdrgw1IkfyNA(EQ)FwVQvjXU*7q*roS7=AJ&~4T1VH4gGmk z1uq*U$|VT{#2D0ew8C=Tm{#<51QsPl+2T9%!h!-Zt(guGq;E3)^E>kybmThG*nbEF zfPwL}aMH2IRwo&ZVwYdI`QaIttrX!m=+82Vn=KT#SyZJ~$);Muoc!cil}hNjBZX4aVDhdr~qjaLcm)*DbapK}$;<9e*W&nVp!IOV~7AJk^7>J10#P`QG9d?yS5F}S0 zd-RUryt6KU%**3=8otVa3?Sx97&?8wKzSOq+jqdu?5x`Dn_}@Z6Ya?4S+tA^5Y(9C+ zar2lO@XZe&Jo1%2t$QW0)5LIBaLvPao(Ib901g6x$m3jGh2;1fMk(Y6)PpHImOKJG z>zD+}k3tge#w@)yH;i%x$U(4*;BV~||JpQk*mKuT{ANdQ)VWgV6+!@D+Jm<=C`sK2 z!6Xn?R6$C~i1Ovt*Fo3S6dEwz8@#)u8joRF$q-ol8gP${^B`-5q_i)QRVC+ z>Q!k}jF13V{MY#w;wW^RvsgRYA$b>iaJ@eO6`aIKpSqu8Bi5Zy zLPWh&>H1U}iM>vihpOL{H?k?~q0RyZJA(d>@`KheXYrd_b>twPfj4YGgcP5&LU4^J zDTOsfg^BUP`Jyl|ph~^AQE53XA108VVb82Cr_Ocv28pbV-32G-i_bjf$OcxdemdlkdQ7~t)Ui^FP*=1cA9gjZi% z#;F4WJht$J3$`Uymr5c*r_R=J+cQ#YLq<0_7=5tAnv}(;vlnGSi^AHR3sW##l665> z!<2FATI1ow>QP}NMhGbzV+F1OUCO|ImK-rEg~kSpq7)@UOcsJIt}gnL&OH3FdGY7Q z`RleebAXWDhA6HtEn{9o=QNZ+MhV|6-)ew-Vf+%Jd)6h8s05YJTB}W{RLVcY@u@uBofTggxV7DaimX0cF?Rs}7Rfi;y z7$L^7Uk+bwD1pv+(0PBn-El<5jC3%#zr`RlZij+P0Ir5%aXOI!mfrh?Z~rZ+IwXO_ z2zlCj`)vT(vIhxxZ61v4Gp3Zt=z|>$9po6Ld`)SE0Gi=U6$3FwFgq#vlR{#Itnxo5 z^Ln=@kZ`x>{fP+xAR>o0S~6syuPGhMfA1iC?ZNPoAD?{wpOTV4DJ1%3YJxBHcw7Vd z?fK%Q2oV|8Xk%bMi>^}eL|{b0P}<#`_uXWqP8JD&Dx9l|n`Mu~WHh`^jWFp`B8MMr zqprqc*0z0TE^^g>pZ<-#zN@_)k|o5T%XdY}@si(`hw+N^+96S8>nWEaFwdps%P>D|DWusFFI zf(yU5X5mqlld^iK$}i+-7x(z{({~Q9-35(ANC5z`XsjD5DPy%z6+(V=#%2EiWtVezdEanGkc5v#CB}^{0fViII2d- zEnl4SB!EA}W-xYR!*r(Pjotz&0-T$KtVyD(zp|!beGi3czCFR@bU0ENCB;z2%>3iR z5lP6J6sk(dEvH|)nu6a4``z(E&63yPigW4csS_$MX>zFg?-061zRNP>Br$Rf{Xr=r zGK(?D;MJH!1WgE4CuIKFQ(h%7x66SjBO*nU#i)h|NE|R(y$!cU&!ynSZck9rPjX0T zz6=0R26ubiUWh(H$epKMnKK@~1ETzg!))bG`H3t6IfmG$epb9s5CQg(v?DNt%9f(L!Tl9 z0FA-L1`_ipx;72Nh}mMqe2MH;uRZS!eT@*@dEu3udf1OQsTGwn^+sM7&#bL;!TKo!VPG40S4qb;o3=?(WH^hrVhV9~`_zFdEbPuf3Dhc^)~vv zh6MP<=fCuFPWTxEdDc+TBm2x}`Sxp^x@1ZEf@Ke0U2QoIU_ZhC17is@_omt1Q2+n{ M07*qoM6N<$f?{JUN&o-= literal 6500 zcmV-q8Jp&bP)HA1tLUz7M2*NyZ?ajFjhmPR&j?vHfXF#_AN4-_M^$%MS9dd`fiWEQ z`Sf&8Rdx5gzy3Yf?|G_60P2$o00Z0rENZB!ZLd!zXsD@W?^e1QAP3GcU=Hx`URZho z&1V_FEdTzi^~uB!8)|9^9NW7EHpxAxPbRv7D*x9MaC$>c?N9fbX$AAFPbN+d00s~T zUaU_h_Swt03ZMaJl{pp%epjDN9IzL-QlI7kpQ~{EP~f>-u-FS+foTJP1GjU|3H8au zYjw%yeHvZ9A}}m-EH|ugp$1A3dk$$~_)9Q=d#oLrv|y!17+s9Syub zJJ~#GPR*47dn|ZTpG=$yYy)Xk~6a@(Hj(@p{&Zm6ksf%Ac$ zawjT+7Ji)${Gl${d=fz29>zEWi~^3VPbQW%)YSd~_!7`ok^`%E9{_Hs!q4lH&2_;3 zdlGoYPb&bXvLU*J@rBS13`ECp21fT=1pDEzW6**vk)_jP*$Xa@&=zqUS^ zxTc||_E)~ywgsuBA#)7{i67S`o0rukoAa+%_n*zXEoehS`|hkyChlygsr^05vA{1i z0FnZ#Ird2y(DQ)b*Cm_h)g_zvX*}gh>UP6~SVDz*5P`=U#@2oVpsuy~*(~PlLWQq| zYF~#+K20s2^wo^sry+1GSE1#c9#cD%K(;p_zKE58^_hYHLLZ$YXlmB zfx(c_3vht`0ayS$-B?q*4xqj@LBrVE-2}9-|MGrx1D7|BoATJK*87G5&j@_JJaEPF zHDJ67Yyo~O%B+U5wI2Y~t!$!k{FGf(<T*PbSV3M~39isBcN^LQHE-q=9HLU>eSBNt-CZdSKCQV=r&K zq4mCzcs+%yiu~Mm85i=0@D|D=4P$G6xNDhbYhshn0w1eVzyLB5!HVP-`=+25-a2;j zZ*OS5Zw&A+f_?^w^lqvpzyYLzOM(ArsHyGV70h#u_5xU$QtBv0UY*r?{|gF7%o{uT zZxopTJiWb?Bn)BTJTt5H zzSXE^=Z?MNtH6=K3Z)b{whtV@7l38;t%)Ds^g<%iIKK8T($@(dQs8nv%zxYlye;TrvHBE7#vsfCJw?g_R}nk~TIk`7 zhBIs3zZj;~wKPpeIT847ku0Lq z1&#p@2?X2TShrf0NsVJ`SN+q=5AgRVerLOj3bV34nHT`^ZH z0EZ%+kdM0C2W}h6wGCryAE<9h&`_Zit7}cr=mS>YnwW&}4dBy$jXfBz%O*eu==78B zwLpunE56?wcv82rX(XO6szS*sOhR~m&iE-hdqvY1K%W9eB45YWwKUNy8w;N;@JR6+USoYSxRM}V7ta?fBvZ|jT|Zhs_p8Qherc93!DXdfP_E^0v8Sle-3bE7pa`zFt+x|*)KJnCBlE;SxO&}k&@%8 z-un-V4bYg0h^tn+vnjf>DRIR7edD+(4MoqMy`t$-;Nc)rTKZwXi?Z;RGq0KtaCOVW zBLuw|m@9dI)LVck2B7aMNk#Con&kmSzvVml;^#`A*o3Q=;R6q_fBUIV%K#@X5o7%Q zE*rbs^cNf6kj_l^(z)ZOURu|Z$bptP2<-auN=FHJnQkZEkTsE|Hf#TQ_ZgSjYg!(f zAztBr80erpC}ji0#|5qe;}mSxR%B3bASy6=-{E?~K}U-M#;>o97zA*{5H%5f`GePa zW9z%$y7`pJOY<)?`^9@!0mo?hhCrUe04XO<#)+l`UPbgpgMH{ncR?D?sJKiVMZL#RH8n7174D4-trx`;*qM@j&z z;O9Pusk&)f{6U8?l2QPzs-FAlQ;3;}h~R-E;)4f*L4^E1M+B?dXaeErQ54%NV1Ag6 zXH#DKQAjloROEWZtODI?k!6YuPfR$52}_?`yNcpIKJgdS!RlVEO#_w%!~-YO)uU9N+;et$2pbQRix!))1;j!Dh8{$ zsF_PeWT2wQ0mpf7r>KgGXn-TRM?&%5!X8nNcIv~cCCkx5StlR{tQ*pc^Nnu*p^|^! zVFQQepI_K3`5-1Gj!*#Ew+P;wesa%2D6@cxphr~#EEiofPL!T#Rk7kBh4iAFDfXh0 zR7^=Kt0aNvS|!_KD+hx>%@H*bP91eT`@{$2%`##fTOKSz_q}6VH?qaZqykcgln84phU_fz2SUrhelTauM)6buE)0E;>uWFbtKNjBTv$Z zaYTTKarpInud{01JH#SUPCxoY4jMGXkE8|QL_|#(up6IW@>x|zqx^2}SyRu)QVm=W z{2th>Ih*xqI3U%TUr4@m(lTXJsH`gFg5gq2N_||p53HP@Q!rIdz;ESl1wWa)MNLFw zk*MStn962Y@#Zhs+TG3v?VEXS)z7eM%jGy-rVPmpkW9n0l;w zX~b86`M|GH5LK#ET}1|&1J0@hz><*iD_+e?sl%^SvsRcTDdwJlID*;$P*%YzYCRCG zwd@lcAd>fof@|HP6lZu1H2D> zAlA00WAQQF@d3vfI0m%ZlToz9hnX@yt1khfg1l4`AXFjKmd?4k!V^@$fK|)r14h^{ zjXc&^wRtD63a_tUO=qf`)tlbuk`pEn5hw4@6#c)E2OT;xQo^(eQvteeSia;k;CDqi zM*%knWsJ{8@6!_@nn{y&qBawW`stuz5sa5|fOvGbc>szN4pBv=cyA#Q3Bu<;!++oK z5iwvKgH2mhLKO9LwNxe(G(0cY6XDq5qsiJV>)JLV{>Li?-YhP3*hAY5%a<_k?5V%^ zqv!TLaL7wnb$6IZHX}tQnon9w^pH@%kct7KY!aOR5jw75;>Pn~wh$144zM%TBZbPN z0G|xm18NtdJX5GW2~`I9)IH!cgzBzN zV(FCUg9E??Bddmj0%ZaOC4y$(1BAp(p$hPCIS{eXlSxa~b+yQRMTk04UU}~|4m)6& zS9|*2KWpu>BMu(<)~JIIEe{&Nya`t^Z{lHC z<))-O-v z)=AS|18RVGwg*@V>j25R4BWaElgXk|44e%$WI)O%xMhH&w*VmqF%n>#@6%LKYuV7Y zMRO`f)QRx()vt2WsN=lzfV9oj9W(rhIcwH#F6l<~X`A)TVs4!@{kN+89m=Y3M@Pdg zc@33Is#LYL5$o*6N-;=QivvV4aFr{F@Z&IWzOq>GX}O#01&+0wHzEiT$KhA+u3~dn z8)FXk5?oj9`77H0FbANUEgz#37}~D?x5W{JXHX{O6wq?QmzEZqU==qOBQiGJR}oAmL)DfxoKzYs;-@18 z|3xT3l$fg)>n2(zk}8tZsXUW(b1d_3R&m7Pzu#WP%C~;WIiERs{m?=CU99S!G-lWl zZ@jr~by>hZ7HGG9b-G`XsNVLq>GuMM0dE%pqa{=eUBCfiEwOFwL_4~QRN5eLTA^kQ z0#|C9A+^_t5=b}vKwz=78RU((*1fmTh6rpiA7gD7LJT9RmK!Cd1pGJ^-A5vQbwT1nKDKuud(#}?X%nawFO zn^Hj$9b-k7|+qC?O5A=vZvyRw8Ykeo0i^Xvu+O%Tx!d5~v1>^F9<&t83MA!lEm$ zTQ;Nlb{1W6?VmTFwj+n#zW2mJ02W*@lj|N|7y(A1{K$*4TH@wP(vn=_9C1hw-4`*Y zIFd>Q={(eb2%2{0!=7wBzJ2@GXPyoE zIpBF!wn^W9fpzi!&y3wGQjB>lL3 z?cO`)$3(t2G%i$`T>ZJ7ltsV}s>0oGFsLmG07fb^t|&mLUOs=^n9Dycq*G1Pi#Zjl6GlJXBl1{WxtqH?B#vnY;_#1iu#~P zt~Lt{2Ihwv5Of>e?%Ex_lz#JRS&1l$iZNbmUkt`Lg?l47j)N7$dtDh;x2FOPUd=au z&Bk_A!Zm3Hl|=dN9TTre@3NqMew2}+`#GjMDj3I*lS++aynEw-F&M{S9EVOvg$`+Cd1?ftmHq=)w zlF{WZfQ9Ey*>yqlS5>SVTT8abr79+J*g+9KGcvBxs8R8KT@E-WV(752Hl599{H8mN zRm~^4wpgrOqr&Ug>C5cW=ILA32EUsZuv?4mc2R}un8>k*$7Se#5pTZCctJwM!Ep?2 zE_CN69kUjb%H&v8EFq~RtKV$fe7l^u>w_k+E|9JV7^m3oY<`sUumd9;bx0h?$)zJ6 zE@8^UYgV{UH_gW@TM4100;{Lcc&2 z-h4kpN4JYwi>PvlT4Gk|IA$cKFva*Y*NL7SOLxKln({5_LH&=tc)@#Ytk-?^I zVH{rI=tH6m85~i>L5-m^CpcP9CQ@)w7U-7toeEgLRs^?U739kR-+AG&-4C=|#?}6;Po7pG+vR!@RSL?5Bgj#I6~)Ai zW}}f@n(?g%PrKmV%T_$W17}{e`+?@O=D+$HrqY|zs9R7Y6^J@;*ry!n9#{n`kEGn} zqnG^T2_8D_f`0k?BYYyL$#T#yRRFX^d`xXhQ}wBM(a7@t0}UAS%A!-hdP#r(`Tfqc zSuZuC=+E)K;-PN>W=9q`ZA)C>e%1E)`efpS{$7K85=6Uk#k~g_vcFc#aBpS|a20C{ z6FusZpYXA+VxorXLk1vPa!u85@xJu4tH1tl!YAU>=AL%N233BuecLSlWZiC;YgtnXe$TRO8S8;pXq7kdWbH~>w6UX+4U;D&B`-kTjqgI|q zKUy<4+mWSo0$fmJAaMR}ZJuqWnt2nZe5lIvC9W;sLn-B-+nK>ia7?~vT=ZfE+1cOX z{E2~f=NXrKeoD-|kCGtSv_-SIU;@RLF31tUUpMY#6aA!p8n;cD@|q$`KgwV1c4z%d z7Nz78Zjc$fdmsQHrOp(*fAH0p5)8M;2D(p#MiRJiw+HRIXPfxZIkjD?I=9za)HhMh z+C0n3ToSq8>}2ynyESOHPxP9(St54>8@HQ(Pq3}^s%TsWP&2ODsS zT&?iaBBCi!74v}--$cC;K%2jaR?{*F?UFY7uMfz&O?xSY_1| zUqt3z_V|B$9B2SnKeCX8--u!WwckYp(0o?iRYni(AZWev#n&k@L z&&K1p(O4d!+*dr>KonJEr?=RJU1+=H*~c!l@#w!gC=M1Qg?r;qgd5Sr7mmAh%^u6N z;C9iAPqB33MUSKMJ&U;3kC-;^-vo=iwQ$^}Yi73m^IoQfw{O1q# zRzEbN|F~rQ&K_8XG`0000< KMNUMnLSTaEvUc(S diff --git a/doc/style.css b/doc/style.css index e0f06f10..5f64724a 100644 --- a/doc/style.css +++ b/doc/style.css @@ -224,7 +224,7 @@ display: block; clear: both; overflow: hidden; - background: #4dc6a9; + background: #69938C; height: 10.5em; } /* end global settings*/ diff --git a/libguh/devicemanager.cpp b/libguh/devicemanager.cpp index e4102921..3fb0a57c 100644 --- a/libguh/devicemanager.cpp +++ b/libguh/devicemanager.cpp @@ -107,7 +107,7 @@ /*! \fn void DeviceManager::deviceSetupFinished(Device *device, DeviceError status); This signal is emitted when the setup of a \a device is finished. The \a status parameter describes the - \l{DeviceManager}{DeviceError} that occurred. + \l{DeviceManager::DeviceError}{DeviceError} that occurred. */ /*! \fn void DeviceManager::deviceStateChanged(Device *device, const QUuid &stateTypeId, const QVariant &value); @@ -123,12 +123,12 @@ /*! \fn void DeviceManager::actionExecutionFinished(const ActionId &actionId, DeviceError status); The DeviceManager will emit a this Signal when the \l{Action} with the given \a actionId is finished. - The \a status of the \l{Action} execution will be described as \l{DeviceManager}{DeviceError}. + The \a status of the \l{Action} execution will be described as \l{DeviceManager::DeviceError}{DeviceError}. */ /*! \fn void DeviceManager::pairingFinished(const PairingTransactionId &pairingTransactionId, DeviceError status, const DeviceId &deviceId = DeviceId()); The DeviceManager will emit a this Signal when the pairing of a \l{Device} with the \a deviceId and \a pairingTransactionId is finished. - The \a status of the pairing will be described as \l{DeviceManager}{DeviceError}. + The \a status of the pairing will be described as \l{DeviceManager::DeviceError}{DeviceError}. */ /*! \fn void DeviceManager::eventTriggered(const Event &event) @@ -317,7 +317,7 @@ DeviceManager::DeviceError DeviceManager::addConfiguredDevice(const DeviceClassI } /*! Trys to pair a Device with the given \a pairingTransactionId, \a deviceClassId and \a params. - * Returns \l{DeviceManager}{DeviceError} to inform about the result. */ + * Returns \l{DeviceManager::DeviceError}{DeviceError} to inform about the result. */ DeviceManager::DeviceError DeviceManager::pairDevice(const PairingTransactionId &pairingTransactionId, const DeviceClassId &deviceClassId, const ParamList ¶ms) { DeviceClass deviceClass = findDeviceClass(deviceClassId); @@ -347,7 +347,7 @@ DeviceManager::DeviceError DeviceManager::pairDevice(const PairingTransactionId } /*! Trys to pair a Device with the given \a pairingTransactionId, \a deviceClassId and \a deviceDescriptorId. - * Returns \l{DeviceManager}{DeviceError} to inform about the result. */ + * Returns \l{DeviceManager::DeviceError}{DeviceError} to inform about the result. */ DeviceManager::DeviceError DeviceManager::pairDevice(const PairingTransactionId &pairingTransactionId, const DeviceClassId &deviceClassId, const DeviceDescriptorId &deviceDescriptorId) { DeviceClass deviceClass = findDeviceClass(deviceClassId); @@ -378,7 +378,7 @@ DeviceManager::DeviceError DeviceManager::pairDevice(const PairingTransactionId } /*! Confirms the pairing of a \l{Device} with the given \a pairingTransactionId and \a secret. - * Returns \l{DeviceManager}{DeviceError} to inform about the result. */ + * Returns \l{DeviceManager::DeviceError}{DeviceError} to inform about the result. */ DeviceManager::DeviceError DeviceManager::confirmPairing(const PairingTransactionId &pairingTransactionId, const QString &secret) { Q_UNUSED(secret) diff --git a/libguh/plugin/deviceplugin.cpp b/libguh/plugin/deviceplugin.cpp index 2e9f7565..1dded900 100644 --- a/libguh/plugin/deviceplugin.cpp +++ b/libguh/plugin/deviceplugin.cpp @@ -50,7 +50,7 @@ \fn DeviceManager::DeviceError DevicePlugin::executeAction(Device *device, const Action &action) This will be called to actually execute actions on the hardware. The \{Device} and the \{Action} are contained in the \a device and \a action parameters. - Return the appropriate \l{DeviceManager}{DeviceError}. + Return the appropriate \l{DeviceManager::DeviceError}{DeviceError}. It is possible to execute actions asynchronously. You never should do anything blocking for a long time (e.g. wait on a network reply from the internet) but instead return @@ -70,14 +70,14 @@ /*! \fn void DevicePlugin::pairingFinished(const PairingTransactionId &pairingTransactionId, DeviceManager::DeviceSetupStatus status); This signal is emitted when the pairing of a \a pairingTransactionId is finished. - The \a status of the will be described as \l{DeviceManager}{DeviceError}. + The \a status of the will be described as \l{DeviceManager::DeviceError}{DeviceError}. \sa confirmPairing() */ /*! \fn void DevicePlugin::deviceSetupFinished(Device *device, DeviceManager::DeviceSetupStatus status); This signal is emitted when the setup of a \a device in this DevicePlugin is finished. The \a status parameter describes the - \l{DeviceManager}{DeviceError} that occurred. + \l{DeviceManager::DeviceError}{DeviceError} that occurred. */ /*! @@ -89,7 +89,7 @@ \fn void DevicePlugin::actionExecutionFinished(const ActionId &id, DeviceManager::DeviceError status) This signal is to be emitted when you previously have returned \l{DeviceManager}{DeviceErrorAsync} in a call of executeAction(). The \a id refers to the executed \l{Action}. The \a status of the \l{Action} - execution will be described as \l{DeviceManager}{DeviceError}. + execution will be described as \l{DeviceManager::DeviceError}{DeviceError}. */ /*! @@ -281,7 +281,7 @@ void DevicePlugin::deviceRemoved(Device *device) } /*! Confirms the pairing of a \a deviceClassId with the given \a pairingTransactionId and \a params. - * Returns \l{DeviceManager}{DeviceError} to inform about the result. */ + * Returns \l{DeviceManager::DeviceError}{DeviceError} to inform about the result. */ DeviceManager::DeviceSetupStatus DevicePlugin::confirmPairing(const PairingTransactionId &pairingTransactionId, const DeviceClassId &deviceClassId, const ParamList ¶ms) { Q_UNUSED(pairingTransactionId) diff --git a/server/guhcore.cpp b/server/guhcore.cpp index 63415d3f..9c19d26e 100644 --- a/server/guhcore.cpp +++ b/server/guhcore.cpp @@ -27,6 +27,36 @@ instantiate, set up and connect all the other components. */ +/*! \fn void GuhCore::eventTriggered(const Event &event); + This signal is emitted when an \a event happend. +*/ + +/*! \fn void GuhCore::deviceStateChanged(Device *device, const QUuid &stateTypeId, const QVariant &value); + This signal is emitted when the \l{State} of a \a device changed. The \a stateTypeId parameter describes the + \l{StateType} and the \a value parameter holds the new value. +*/ + +/*! \fn void GuhCore::actionExecuted(const ActionId &id, DeviceManager::DeviceError status); + This signal is emitted when the \l{Action} with the given \a id is finished. + The \a status of the \l{Action} execution will be described as \l{DeviceManager::DeviceError}{DeviceError}. +*/ + +/*! \fn void GuhCore::devicesDiscovered(const DeviceClassId &deviceClassId, const QList deviceDescriptors); + This signal is emitted when the discovery of a \a deviceClassId is finished. The \a deviceDescriptors parameter describes the + list of \l{DeviceDescriptor}{DeviceDescriptors} of all discovered \l{Device}{Devices}. + \sa discoverDevices() +*/ + +/*! \fn void GuhCore::deviceSetupFinished(Device *device, DeviceManager::DeviceError status); + This signal is emitted when the setup of a \a device is finished. The \a status parameter describes the + \l{DeviceManager::DeviceError}{DeviceError} that occurred. +*/ + +/*! \fn void GuhCore::pairingFinished(const PairingTransactionId &pairingTransactionId, DeviceManager::DeviceError status, const DeviceId &deviceId); + The DeviceManager will emit a this Signal when the pairing of a \l{Device} with the \a deviceId and \a pairingTransactionId is finished. + The \a status of the pairing will be described as \l{DeviceManager::DeviceError}{DeviceError}. +*/ + #include "guhcore.h" #include "jsonrpcserver.h" #include "ruleengine.h" @@ -38,7 +68,7 @@ GuhCore* GuhCore::s_instance = 0; -/*! Returns a pointer to the single \l{GuhCore} instance.*/ +/*! Returns a pointer to the single \l{GuhCore} instance. */ GuhCore *GuhCore::instance() { if (!s_instance) { @@ -47,37 +77,48 @@ GuhCore *GuhCore::instance() return s_instance; } +/*! Destructor of the \l{GuhCore}. */ GuhCore::~GuhCore() { qDebug() << "Shutting down. Bye."; } +/*! Destroyes the \l{GuhCore} instance. */ void GuhCore::destroy() { delete s_instance; s_instance = 0; } +/*! Calls the metheod DeviceManager::plugins(). + * \sa DeviceManager::plugins(), */ QList GuhCore::plugins() const { return m_deviceManager->plugins(); } +/*! Calls the metheod DeviceManager::setPluginConfig(\a pluginId, \a params). + * \sa DeviceManager::setPluginConfig(), */ DeviceManager::DeviceError GuhCore::setPluginConfig(const PluginId &pluginId, const ParamList ¶ms) { return m_deviceManager->setPluginConfig(pluginId, params); } +/*! Calls the metheod DeviceManager::supportedVendors(). + * \sa DeviceManager::supportedVendors(), */ QList GuhCore::supportedVendors() const { return m_deviceManager->supportedVendors(); } +/*! Calls the metheod DeviceManager::supportedDevices(\a vendorId). + * \sa DeviceManager::supportedDevices(), */ QList GuhCore::supportedDevices(const VendorId &vendorId) const { return m_deviceManager->supportedDevices(vendorId); } +/*! Removes a configured \l{Device} with the given \a deviceId and \a removePolicyList. */ DeviceManager::DeviceError GuhCore::removeConfiguredDevice(const DeviceId &deviceId, const QHash &removePolicyList) { QHash toBeChanged; @@ -113,86 +154,123 @@ DeviceManager::DeviceError GuhCore::removeConfiguredDevice(const DeviceId &devic return m_deviceManager->removeConfiguredDevice(deviceId); } +/*! Calls the metheod DeviceManager::pairDevice(\a pairingTransactionId, \a deviceClassId, \a deviceDescriptorId). + * Returns \l{DeviceManager::DeviceError}{DeviceError} to inform about the result. + * \sa DeviceManager::pairDevice(), */ DeviceManager::DeviceError GuhCore::pairDevice(const PairingTransactionId &pairingTransactionId, const DeviceClassId &deviceClassId, const DeviceDescriptorId &deviceDescriptorId) { return m_deviceManager->pairDevice(pairingTransactionId, deviceClassId, deviceDescriptorId); } +/*! Calls the metheod DeviceManager::pairDevice(\a pairingTransactionId, \a deviceClassId, \a params). + * Returns \l{DeviceManager::DeviceError}{DeviceError} to inform about the result. + * \sa DeviceManager::pairDevice(), */ DeviceManager::DeviceError GuhCore::pairDevice(const PairingTransactionId &pairingTransactionId, const DeviceClassId &deviceClassId, const ParamList ¶ms) { return m_deviceManager->pairDevice(pairingTransactionId, deviceClassId, params); } +/*! Calls the metheod DeviceManager::confirmPairing(\a pairingTransactionId, \a secret). + * Returns \l{DeviceManager::DeviceError}{DeviceError} to inform about the result. + * \sa DeviceManager::confirmPairing(), */ DeviceManager::DeviceError GuhCore::confirmPairing(const PairingTransactionId &pairingTransactionId, const QString &secret) { return m_deviceManager->confirmPairing(pairingTransactionId, secret); } +/*! Calls the metheod DeviceManager::executeAction(\a action). + * \sa DeviceManager::executeAction(), */ DeviceManager::DeviceError GuhCore::executeAction(const Action &action) { return m_deviceManager->executeAction(action); } +/*! Calls the metheod DeviceManager::findDeviceClass(\a deviceClassId). + * \sa DeviceManager::findDeviceClass(), */ DeviceClass GuhCore::findDeviceClass(const DeviceClassId &deviceClassId) const { return m_deviceManager->findDeviceClass(deviceClassId); } +/*! Calls the metheod DeviceManager::discoverDevices(\a deviceClassId, \a params). + * \sa DeviceManager::discoverDevices(), */ DeviceManager::DeviceError GuhCore::discoverDevices(const DeviceClassId &deviceClassId, const ParamList ¶ms) { return m_deviceManager->discoverDevices(deviceClassId, params); } +/*! Calls the metheod DeviceManager::addConfiguredDevice(\a deviceClassId, \a params, \a newId). + * \sa DeviceManager::addConfiguredDevice(), */ DeviceManager::DeviceError GuhCore::addConfiguredDevice(const DeviceClassId &deviceClassId, const ParamList ¶ms, const DeviceId &newId) { return m_deviceManager->addConfiguredDevice(deviceClassId, params, newId); } +/*! Calls the metheod DeviceManager::addConfiguredDevice(\a deviceClassId, \a deviceDescriptorId, \a newId). + * \sa DeviceManager::addConfiguredDevice(), */ DeviceManager::DeviceError GuhCore::addConfiguredDevice(const DeviceClassId &deviceClassId, const DeviceDescriptorId &deviceDescriptorId, const DeviceId &newId) { return m_deviceManager->addConfiguredDevice(deviceClassId, deviceDescriptorId, newId); } +/*! Calls the metheod DeviceManager::configuredDevices(). + * \sa DeviceManager::configuredDevices(), */ QList GuhCore::configuredDevices() const { return m_deviceManager->configuredDevices(); } +/*! Calls the metheod DeviceManager::findConfiguredDevice(\a deviceId). + * \sa DeviceManager::findConfiguredDevice(), */ Device *GuhCore::findConfiguredDevice(const DeviceId &deviceId) const { return m_deviceManager->findConfiguredDevice(deviceId); } +/*! Calls the metheod DeviceManager::findConfiguredDevice(\a deviceClassId). + * \sa DeviceManager::findConfiguredDevice(), */ QList GuhCore::findConfiguredDevices(const DeviceClassId &deviceClassId) const { return m_deviceManager->findConfiguredDevices(deviceClassId); } +/*! Calls the metheod RuleEngine::rule(). + * \sa RuleEngine, */ QList GuhCore::rules() const { return m_ruleEngine->rules(); } +/*! Calls the metheod RuleEngine::ruleIds(). + * \sa RuleEngine, */ QList GuhCore::ruleIds() const { return m_ruleEngine->ruleIds(); } +/*! Calls the metheod RuleEngine::findRule(\a ruleId). + * \sa RuleEngine, */ Rule GuhCore::findRule(const RuleId &ruleId) { return m_ruleEngine->findRule(ruleId); } -RuleEngine::RuleError GuhCore::addRule(const RuleId &id, const QList &eventDescriptorList, const QList &actionList, bool enabled) +/*! Calls the metheod RuleEngine::addRule(\a id, \a eventDescriptorList, \a actionList). + * \sa RuleEngine, */ +RuleEngine::RuleError GuhCore::addRule(const RuleId &id, const QList &eventDescriptorList, const QList &actionList) { return m_ruleEngine->addRule(id, eventDescriptorList, actionList, enabled); } +/*! Calls the metheod RuleEngine::removeRule(\a id). + * \sa RuleEngine, */ RuleEngine::RuleError GuhCore::removeRule(const RuleId &id) { return m_ruleEngine->removeRule(id); } +/*! Calls the metheod RuleEngine::findRules(\a deviceId). + * \sa RuleEngine, */ QList GuhCore::findRules(const DeviceId &deviceId) { return m_ruleEngine->findRules(deviceId);