From 05c77431cf08d5c0760a3b18f08a35cd2f467068 Mon Sep 17 00:00:00 2001 From: Christian Stenger Date: Thu, 12 Sep 2024 11:01:56 +0200 Subject: [PATCH] Doc: Start updating documentation for Axivion Change-Id: I4213ce43c02152d35fd8eedbd7c5acacf1801ce6 Reviewed-by: Leena Miettinen --- ...qtcreator-preferences-axivion-project.webp | Bin 6674 -> 0 bytes .../src/analyze/creator-axivion.qdoc | 63 +++++++----------- .../creator-projects-settings-overview.qdoc | 1 - 3 files changed, 24 insertions(+), 40 deletions(-) delete mode 100644 doc/qtcreator/images/qtcreator-preferences-axivion-project.webp diff --git a/doc/qtcreator/images/qtcreator-preferences-axivion-project.webp b/doc/qtcreator/images/qtcreator-preferences-axivion-project.webp deleted file mode 100644 index 1a1520909f16c5b9a413dc8006bb334eeae31d84..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 6674 zcmWIYbaUg9Vqge&bqWXzu<-dO$-tmL*)f{oUcnuYNlK|d^1m6qKd7vvw&1*K6QkOO zi;o;%&kT;r+HuJH9Y?)wuFIjOwY}3*wk+ydS2S_k+yB8bJ1eIfyjgbmjLhL2y)$Rd zyfJt?_kEFPv3Lzb>u0WAcaG06KVccW|Ns6~yS=Y2O*QV}F-|*waaQ!fxS6S87G6AE zsZXyQJrp=YZShGT&(rLE+kCsG^jXg-C~Uu3$yHwd_Tb&QQFm-#%apH}(%zB2=n!9^ z`%Gzuo43rip4=-keTsZ}`P_uk?`2)PU*}w$%KvWLpTZ*c&8IAPa;sGT((m55c0=#G zVBLwO7b`8w_U>z#TXSjBfB!=1yXwDpwV&9>>6Vhl&3j8d?l9-JQvp-AKb?AR!A|G+ zlXw41Y9}9EdfY%=%Xr1H&8xEdk8kEPHa0Gwv1Eg1oB@kM`tSMMBH8<5mE4%tU==ENC}uSEVl z|ImJ=o+IzJ$D}ouWz9alJ-7b4Fl^vD6_K++BPnD>&!I!6OlwXY5@mJQ`M}j6vZlcG zA!Ad|p=00Oo{Jf43XA>u7oJeUn%Kw~ALp{z%)V)jTGz}KW(-j(59h7uTU6lB(pK`| zuc3&DLjg}g`|iTkk7t#p?`^-xV^-t$FQHW=w1WN0-4g#j#zp*6RvpU(jtGZ#i{`!K z`L^BdY_E}cwH8OkD@Fblfx@9FdAr!(OT4zd-|%-sVDWJQgLFxaPtm^T->z*?=Tcnw zH0#BQixXCOhL&Gep2in*{nS-?fwS9>ER$1x_u`tk%i<%hte2WZSHD{@Z&$PJ`_7wu ze@`Ekaa_7OV&f4{rm)*GllEu$hqUf^&6VRCdp`T<%L?~c-%5d?zYqTJ*WuXD^}B-m zO^wHE`Jk%bEL(+B92q9d7hT!z(!jxK!I654KeKeP>_3-VE83SNOkfIBWn7pq&>hOK zOjzlcAKw8tef=%ZoTZvY7BnqRH@)IFaqjC|)ftn&w=a3|_M2i>5XU_O#R&&~O*o{G z`pLQPUY`6SzxUjoP7A7kSG#PGW#XD=`^B$bc|+u4zYEs(->OqqzU9{}U3_EP_t2w) zU+(?B_D|xUS7&&DHDjLY`)S|!b}^h=yYKI71y+`KKT@S{N53s{G`CXl2~GU$A6om{ z*(*QZZOb#OJG{5wu3h8do6Tn5Hf!DO#Qt5|_XoN@S|9Bp*zmHYgG_&OK+Dt#{XT zeeM(%nfGADqg0pQr4yI}?z~$5q0~=tY6Rv~;{BO!_{QYBfeRAYUCjUvR&b!vi z_ZKgJoiSfJKl(wM*VZjc-o?vSznI^CZt`j+-_7c$U(DaHy~4(G)3NTbw#DH|7azS4 zt>Ou4Qs+CIbm_%Mf7Yp|RkF8y;AH;b8LYpc4y!53g-9cY$mEby(nO!d#8I!jD+vU)OOy$UsfsC{_lLgH@^O#z_RcbS^fSu z3nv*BR%iUUb~F2`!oq_yDmEOO757lTer7qv7D7ccOPR#@7T z!<{8pHG9HAuA1H{(kxdRrpO;jiG1hSVDs&IHdFhBn_4%U8Ip|VG4sY>sPFnKeI#ny z)B5A zcD~r2+CNW!f4?Kucz8|IvNiiA7VgAFUE7JQzT9}qgFiqGe0JvTes4BT{lV$N)@h&iPq^!jz_i;q@I1Q&jta`$KHv`Oj) zV(Y!CMbwKAdUoy?e6a3_z@=#tSBr0iK8=*K=6>$X7@Nqv!ChrSo0=`lwV*Kd>&yog zR4LpEW1Z8%wU@C|^VplL$J=MA?`fLz<&dCSs>V}~n_C2^cckWresYY69`c6m6bM;n8 ziKT6Kx%(t6It02zH8mEnvSEW=NS*jEnSiVnQ zmoCKlsnaw2>dj>f9-Y0IQGL> zvx>XYznZSsIuk8$_RFOi<)zB{z28>;yS{#tU7O#LqmjZBE-d_hL12qy#_Eg;@7$7}R9CS_iH=$i z7c(8`ePcN(@X$|&g@MKExN8&-)|}?vmfRucd0?@^i2(6vKJ#7dXY7uPP7~l%VDojl zzhdXnGc64Qi61rk4$Ny%WPjpztLchMKqL2UcH_?V7kO4V{)piH%;>bjYMbB$6S1EXt@rrI78#9We;m(Q{)r`SU$#;pPkSw-0t;|bD4`z9IM#Q z?=AZdtno6lnms$o>rE?QBT z8IX_@lo!ev%CID1qG&-v-kK;`tp|@pw_fzoo&VISIcAGA1Me;t#{(7mngJnxEWxE0 zrJu>Y6y-`WzWT7>c%z|Aq@R$ouTwyyw~8D0M$=h8)RVd7zO!fibN#0_nSIfLyDQl0 zPp~s(zL>R8Wd)Cnoq=z#o`qoLqOLEc?dePoCu~DPS3l-D#NE==(7?$4%XQRC%F)YmVIwQkeQnI8=Kwh$U)$*}nAMv`Z_Ve*3oR+T9?d>svR+ zzpm=tz0^VLTBthRL z(FbM!9(?=o=b-n2-%+#IRmNvOZoNL8dzRVmkgF!K@;_fH#m8AEoiI}S%6@KVo``3f z>4Hm4!Hj(iL+4#O{^QrLZ&wXDFRgdEo5C~YS6Y|LSq-khKVFSTua~c{|MjQx=jz$v zsqHV$&$ri)|M&9oabrQ2y_4K@WG$|zu+HsIh?9LYt>yFcFRXJJq^+)}q~DwPkeSI| zM!wp;QT471+a>d^vuvJMie5TCW1QqCK3DPQ6uTMs{?3j0;r8rGyMNk$)i3im_bm%? zom-n{C}3w;W|uYTyPK{0=jRjNcHeHEUFqKBFQ5{v^2DL4e);Rh#&1=RHYxsHp!6i@ zJnOj)uPsl`T4XP&FgIuEF|94^JzFlUczULauiVSg{m7S0rP?VfKUf;OUb;3Hzu#b+ z)fPL6_cp(muK1*%DXZfZ!cv!B5Q&{%bm*M>2DvhiNu4h*v(!#`bUDG-m`(G^p@iQ$ z=ZofBb*(+X;BY!U(ROFk3_IV36eG%iZbkPyNtYoX{+h)FI z-~ILbrf!B!N}Ye|{>*P{KYZ0QMtH^N8FAvp4$jo+q~ zn_iiAW9#{+k5bw0yBWV%6HPJdSCDM&UK(aJE1x;}r0K`J9__n%(*x$ma@ z{@5O)S^2`N%O{%|&B|ZgTAuu>>0*uaN45)xcN>1tdV2Ef3!yK$TfXI8a@M~3A@|qR zIFTO~?R#%5a#v{d4tuyLW}@vcGm)-#b>Xi}6U7e4>73cVF!R%gBS##Sc-!_y%*a3d z;p2ytpa{n$hc}2zf6kQ%tXNqh@hvHJAMex04?AOm()xXG4pq+9jgVJ-Ijo~>h9}hn;G$KhxlI~sp!}> zJKo;T$UGad(0#%T-hjN5T(z?=ZA^P}YP+Un_OVShvx7FK<(%HGDVlw3Tg~iA8`IXD z-hT1Stc@pMU%dC*=+O3yXJ>7^aFpxmK3|!Zzh3%|=EtAeG)Y7}$uYb%O@GtjLjA*f z2h81O9(sTE4x6X%=lx!FWd_=xb6N6gefz>~Pk#05Om)6db1AQ{wYOT*wWdtV;K_Uj zv(T?GzCL^tf`an;*8VhGTfgr2`J98F1XF@TSqm*03Y@^gcEam>h0gDFYCO%@FuABW z=j`^znYZK`7i&v0D{su1G+*}2zIE>IdzW{u{cRTbe&wR>*~#(U9p6JV{nyp%O<#ZG zjc}>E>-Iu}um^%J_ain=CJmv3Ze{k9QuBg%BT%rpM9%Cd#}6)9o8Mf<^Rpmy zi(1(;{i4HD6xTS(-SyUbR`*4Sqtje@$_hItEN*ajL$3?2^dUZJqftJ-J@u zx7FTmjcz)8F8QZkY~j(<#hahU&ErnoBlAG({r|e;oeC$5@9tl|(QZLhOf1mmFzAMXmTW>u+!)Nh-w*E<$ z3wKz5Ke6QGa`55OQJ5nu{Pv^3$vW}P-cPEwo3Y=$vBCaaU#C);U6bOsQ@@U|>NY%spOI(q(Y#iNu3>b;y%K{l8xQe^q+VXiQyXBWmATY$`?)VB2)z=HZlP zLoOYmIeKS=RAw6R9N)9xN=F5wn0d8?`kvC-qUN}u9Sc-Wwj^3SW980r+4I2R)LA(- zX$9jm!aF#W_7x&@X`EJU$kx4F0+)fnjU@H_L8WNB=1tL z8y3fyPG4F7MaOMw94DvVsiixVew%GNd9bK#mj1VU+Fp|zj+)Ef*lgPLcGnU$gN_f` z4T}VO2hYA)bt}eCf==Xwa}9Z&AHsTG5)kbxbRI`Rryzkw6)hhU$N?G!2V`m zr#F(EjgM?Yl4kSu{Elk7G0Wj$Xx^;-ttWn;DZD>jU}L%k)66L=k_u947?vznia2Sc zVjGrfnS5BFx=o-!sjpioG{n7aX8)Sg*N(`n3f?1da(iN4+o9Tcr#mL`djc05aYp1^ zZuHzYO)+Y+hk5b2opa9K7t%61?&lb{m3?Z9vhd<*r*u<3@0k*Dzwq_%b8LIQf4j$@ zAbINhv7kr$dUGtgrNX>cZ>gERBIMS;WtIE+C+`S-De0H_Y464eM(sW<@oJ-$xIV{;%8y#SF3@)8|>1*zi zM+u@X4#AOmDxaTy+ry;9xNTo9%{x{Zb@U8V_@hr3jc1!r5#PUa)tj%Wu2HUEzb-wx>{q38 z=E-fs=4@NLa`&>%JMv_4s@a#lXM1;Ty;MC*IxapeN3FK3^6$l?f6iRAS@gkr*^HVk zXP%v%n)+*N&}pBjSHgwI3d9n9=DUBsXgu3zf7mG>RdM;F9Sa3oL53Ok=;^f&5c!X{Qzrj#Dj89RP{ zSyJ1}!ggY-zM34U$LuMaO~hZ*j{--^~6b zk;jU6D_c4)6uI6!c0=maM1>_2Hfklzz7)F3`uwXB2h9&kpM764FgTqSIsk@nXyUo*JJA%fA%nLq99oL4&KM$3lBN!z#=-qrAk@qtg6j#Of@$+$~j{<#L_su*kA-crC zXy4(+?i)Y*wO{`1&oy~B{h8>O#f!C%=dTm#*qSucba#m9Zq-+6+ZU}`wd=0>ANxbs z1ln(VL>D`TCMX+N^;o6wEc9KaNUe}9tZ1wF_p|6W&U zxoXw9%z4h5VGZ1ey+yVhUMFOFti{IWCSfa4hk z2}k|HrS|hbwD%>jHY5w0uI=-E)A{XiZpeF6hIYLdg>M2p{Occ8`%YfR+X)gp`$Xft z(Kg-AWjE)Cw|B`?;sPJ13tEyqCIf*H`b4-&VYK`(1nH=bM)j%m0?l z+j#uf{QeViudnkPeye?+D4oEv_kpJa-$Rxf7ByFq4fk*VmvsJd|Hq4$_I5RfE~T;T z3^RVei5KbSs(Nt0=bP%69>p4?ApcEf4ChlPPc(Cjt`d(-ou<0?<~50mT^Hj*-YMNa zq+G01D4_lCke`E>_?(o@+o#%ihouQ_P+~iIDQ98)+B>NyQ?8x6?0r0Pll*tXsa@vn z6U7cD?A6{EU;ANC@XU<1EE}WSDUX$P+YinP&+%`&7#mURv-I$@=I$EHi9c4KN9aI)69&M$v~g-zP-Qcl+q_bSkT*eyQ<}nvyfmN>y9)*RQ>_ tcIv&b=%2SHG376-=$vg>J}=DB{P5Go>1OM7HTRfa*2??4F@9=L1pupu)R6!H diff --git a/doc/qtcreator/src/analyze/creator-axivion.qdoc b/doc/qtcreator/src/analyze/creator-axivion.qdoc index 2ac7967c39d..210ea73c503 100644 --- a/doc/qtcreator/src/analyze/creator-axivion.qdoc +++ b/doc/qtcreator/src/analyze/creator-axivion.qdoc @@ -14,25 +14,34 @@ \note Enable the Axivion plugin to use it. - To use the plugin, you must set up a project in the Axivion dashboard - server and link to it from \QC. You can then see found issues in the - \uicontrol Edit mode, issues in the \uicontrol Axivion dashboard, and - issue details in the \uicontrol Axivion sidebar view. + To use the plugin, you must have access to an Axivion dashboard + server. + To inspect issues found during the analyses: - The editor shows found issues as inline annotations. Hover the mouse over - an annotation to bring up a tool tip with a short description of the issue. + \list + \li Go to \uicontrol Analyze > \uicontrol Axivion. + \li Switch to the \uicontrol Debug mode, and select \uicontrol Axivion + in the debugger toolbar. + \endlist + + The editor shows found issues as inline annotations if the project matches + the currently open one and the respective file is part of the project. + Hover the mouse over an annotation to bring up a tooltip with a short + description of the issue. \image qtcreator-axivion-annotation.webp {Annotation popup} Select \inlineimage icons/info.png to view detailed information about the - issue in the \uicontrol Axivion sidebar view. + issue in the \uicontrol {Issue Details} view. - \image qtcreator-axivion-view-rule.webp {Axivion sidebar view} + \image qtcreator-axivion-view-rule.webp {Issue Details view} \section1 View issues + To view issues, select a dashboard and a project. + The \uicontrol Axivion dashboard displays the following types of - issues that Axivion found in the linked project: + issues that Axivion found in the selected project: \table \header @@ -87,8 +96,11 @@ match the pattern. \endlist + Select \inlineimage icons/filtericon.png for a column to set or clear the + filter expression for the column. + The information you see depends on the issue type. Double-click an issue - to see more information about it in the \uicontrol Axivion sidebar view. + to see more information about it in the \uicontrol {Issue Details} view. \section1 Jump to issues in the editor @@ -108,8 +120,7 @@ or \uicontrol {Target Path} column. \sa {Enable and disable plugins}, {Analyze}{How To: Analyze}, - {Link projects to Axivion dashboards}, {Analyzers}, {Axivion}, - {Analyzing Code} + {Analyzers}, {Axivion}, {Analyzing Code} */ /*! @@ -150,31 +161,5 @@ Select \uicontrol {Highlight marks} to highlight found issues on the scrollbar in the editor. - \sa {Enable and disable plugins}, {Link projects to Axivion dashboards}, - {Prevent code erosion} -*/ - -/*! - \page creator-link-axivion-dashboards.html - \previouspage creator-how-tos.html - - \ingroup creator-how-to-projects-configure - - \title Link projects to Axivion dashboards - - To link a project to an Axivion dashboard: - - \list 1 - \li Go to \uicontrol Projects > \uicontrol {Project Settings} > - \uicontrol Axivion. - \image qtcreator-preferences-axivion-project.webp {Axivion settings in Project Settings} - \li Select the Axivion dashboard server to fetch projects from. - \li Select \uicontrol {Fetch Projects} to list projects from the server. - \li In \uicontrol {Dashboard projects} select a project. - \li Select \uicontrol {Link Project} to link to the project. - \endlist - - To unlink a project, select \uicontrol {Unlink Project}. - - \sa {Enable and disable plugins}, {Prevent code erosion}, {Axivion} + \sa {Enable and disable plugins}, {Prevent code erosion} */ diff --git a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-overview.qdoc b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-overview.qdoc index 942c42bddcf..88dfd89f599 100644 --- a/doc/qtcreator/src/projects/creator-only/creator-projects-settings-overview.qdoc +++ b/doc/qtcreator/src/projects/creator-only/creator-projects-settings-overview.qdoc @@ -81,7 +81,6 @@ the project: \list - \li \l{Link projects to Axivion dashboards}{Axivion} \li \l{Specify clangd settings}{Clangd} \li \l{Specify Clang tools settings}{Clang Tools} \li \l{Override CMake settings for a project}{CMake}