From 2ac8f8f6effc735bca60ed171f73d8bc70978056 Mon Sep 17 00:00:00 2001 From: John Van Drasek Date: Tue, 14 Apr 2015 15:44:30 -0700 Subject: [PATCH] max5847: Adding doxygen comments and removing image Signed-off-by: John Van Drasek --- docs/images/max5487.jpeg | Bin 5014 -> 0 bytes src/max5487/max5487.h | 13 +++++++++---- 2 files changed, 9 insertions(+), 4 deletions(-) delete mode 100644 docs/images/max5487.jpeg diff --git a/docs/images/max5487.jpeg b/docs/images/max5487.jpeg deleted file mode 100644 index e01d2ff71be65a9ef563371f73b990989e3c5315..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcmV?d00001 literal 5014 zcmbW3cQo8xx5s}vL4@d?k%&a^oe%^;5WPioV?-Y$c$APtCy|gC(HVveW=4q?VRRvw zAOxe1-dmX0^W1m6cdh%^y?38={yKZ@_5JL#&UYW;PvR_a%|KUQ7a$=a0Ulp2fH(zc z1Jsn1RFo9dR8&+nG}Kqa1w|!g?Rz@9 zdiV7W%pX};T3OrJy12Tzdw6oroN%^Ysa_FE^K#C@5qnQv2onbiOIQn{KDeW^2#bM2#Ke!k#xk$;$$;hex<{}}5UT!i*atZ+{N~XJ}RL=g_1*M~@nYGgMk?k}f z8MAGcCjrA(ScPQgZtVPx_7BZ7y!YRvCuM7|n}W9cHLk3T}|h(N2{oj(pc_Lk#&$eIcDjrXa- zi;7D7Ra_m)k6`?`jY@xz7B*;r<6#dwL3dM4LwR#<8&W*InDr{SbSq=hZCr zSqTyhcD)$+?Fv;1p~~WPV`gq{27{_c24>)SH>n-FF5Q#$7A)T+e!7LBmS-(GGaVN_ zAkCKu6RS^Nh@YeZ=~}qorvZ>(VEw$S%)pIA+RR_^wH;SNEQt%-WqhgE0 z40if&u6s#Km7&N2(2u#ic(9xv^HE6L*jpaHec~KMjpSzBOdgM2IbYAh}D?f z9z}QUtH;A_Jx{iMV|hQx^+k!#2VPk<-F)%^J8-L;QW6z2A`9t9!nf67d0IODX{oa<}(n1y__h}&-eVj`MJF+>`kk>2I&yZ?%hJ z`NE`#P64kl7W91#2uzci`SPyAit~%|d68}Ka7|9g?w9VLu`x0!dZ>^V&YjJQuxhXG zzr)@IOdC?v_Q=GP6=;4dyP_nFQ-pi%RR^{A=z#BVqceB?7Os84Yt>u`M64x#ce zhrn=C$NE>68JQ~+<-?$ZvJc79&Fwas5fjo*c=a$Z`7NW34dB*$YZSZT2bfgU=StoLvP zaYMsX^AHE6R!qO&t}~>Aod+X6bcRd(5v*O2T7AdrPd%GL@O-^-!vHynU2^yJV|Z|C zB{pxu*jI5JvwLQkLFgTy!@NwSPAJ%)t6_^RtG?>EPyHl9Nv;!uh$+z3XnTHT2oE zixpR)n33H{VqY6Sx0~H?WWbwR+u7+Is&v-J>w(jfeTrUDHEg^_%iZbw5aH(9*pM}y zPnW3rqMO$nuYPf$Z9K9VjR=-E*|(~HG*e0QOR0@x;2y>{_faH$O4e5mrjAI?kvXH; zAG1NUF#|MijGx%oGFtJrIpW#nD>EX)>syXWVjU`N!}1F~pnl*qo?VW9KF&uP?A7zO2RIeF8LW6GAAmhDAd@LZm9Z7#JYfkAA*(m=%E_SB6bir`M?rn{=+B7 z@VH~D1ANWnwjbp>tQ16=jThTCDY5S3oEq@*E*C@2%|9XOAZf$%+}f2dCZ8^P!HG*i z;H@HVJLtL%vRZkLW{%=vq0BjdYNovVvy>g`A%P08iI7j;~+sP>;wfk z4OoR=&FIp?U)a?cJ-O&QJj5B*WXudG{L+}nq}JeVW-u}Mz2n{@vGEu-vf+!!*j*Gx zNl7#7K7J?(nn1$}8t%fU^th2ar9<3iN&1|>6`4rBOOoYvl`Ypih-fL48_ccH6JjkZ znJ|9x;vo^JbTUR|mrQhHLPnYtqf1TeV?PJ3t=VSbLTbGxYqXsgG$!6`%E;_2NgzC| z?FmeV5SL{n`b?`)^C}y(N-cumuo?0lBQV-owR&?)uhmG!obzprW)sUOmOp9RKe*B?6Cjt|mS$Zx@2fkMy3w1Q^`{s82L`B*V5$zN;F|ovExTyfssDL84O(r+1lb zT+MoFKecgm?^hU=+c<`n-i;aDRLS&pl~y&^mrfo^-|JSmo-$44TT*4mJ&hu?%B(OG z0n66AI*df1!s$~%(LQz6COx9I|60pT2OPcC>O7o{Wif#7*a)I$2W}?k#dBF_tYtFYp=-lmkp0!k zUo@YOhN7ap7oQ8bL4xPO&T0d>mHtb*;8>JhjHIOUUf$QnA^KzSU2K=F7S`WOMcbdd z|L{izw$_h>3OB_84{#h7f0{mUYx=puo?A= zSH7cU3iT__(>q@?Q(CqS&TGvE^QY^(ic4pm`HaMTv4UmEzuv8_N zJ9^=i<5;W4LwX%;Qdl&}$&wD*-B#D`>i0@$YwbFS(<}GxK!QFrh--(THGAGmhW3#2 z;qr>zy{!;%N4fs=PL5kIk)3I9c>W{0jBt|C@#;VPEkX*1Azmf288cmO7|&@=g}Y;z z*t)BF=D#dB_QiC6n7n(KB_yBjz@?j|WP#10G)UqN-BirKefnEOl!o3L%w}!4a4G?79b~#tl2?{lU4s-qI0OCHV1cz0?OaVZ9Mc-4^CC{+V5V zG+2}!`a4R@NxOc`9kYwrxF+M+A5!_M>8aY!*e*@={dKLxU-@i@&_mx!NO8Rv#b?C~ zInxVd1WjchkCu%Y&dAf5_OLigk$+DK&#`}qxDOFXG#-Pgta-ge1C=_jmUIqCYu7i| zza%Q=$D5Xmb&IL5-!g7va0-9rn?m3tQ&Z@eVH^=|_}p3_p|s(SMBkh)=6#yu`p~{K zf59SI+oTS;W0f$&Wer(QFJ^+<(Yo`iGrx~k#4GwY5d+Ie7=`nmckKiVs z3Nj=P^ey`F5Tjnv! z7TDv6`7rt(cZ`NtoF?AqF?D;l1z$(^5PQB%)>xiN_nfNQ&6hd#^*huJS;I7G?Y^I~ zKPXM=gJ{mKnwpydtmRsXgez29kiY0!pLc?w4aA>*4oavg={?Nsl(@x<93oq&d zdw$r8*OLse+&E!cja1$qPcGD(TY<=_B+EYwNjcmpnox9^yg_y4({j?$)?nC9rDx$+ zP)7lH=$1DT@IKQ^lUeYYI)X-AdfVHEOVx>&s$KqF{wj))ceE4Ll_wcs5uqWtl)ZCD zXZXNKz0deZDQ0^*N6BrHbAH}Zt7+;ZRE-FHs+@M3=T;s}uD0$2A6ol9iKkbdVdfG@ z=0?&*n4pZ+8Nu3(QNKHh0OutJSjgqh<J%#J>QY0ju!< diff --git a/src/max5487/max5487.h b/src/max5487/max5487.h index cf1e8bd6..96c5466d 100644 --- a/src/max5487/max5487.h +++ b/src/max5487/max5487.h @@ -36,9 +36,16 @@ namespace upm { /** * @brief max5847 digital potentiometer library * @defgroup max5847 libupm-max5847 + * @ingroup maxim spi digipot */ - /** + * @library libupm-max5847 + * @sensor max5847 + * @comname max5847 potentiometer sensor + * @type digipot + * @man maxim + * @con spi + * * @brief C++ API for MAX5487 chip (SPI digital potentionmeter) * * The Maxim Integrated @@ -48,9 +55,7 @@ namespace upm { * PMOD module](http://datasheets.maximintegrated.com/en/ds/MAX5487PMB1.pdf) * from the analog PMOD kit. * - * @ingroup max5847 spi - * @snippet max5487.cxx Interesting - * @image html max5487.jpeg + * @snippet max5847.cxx Interesting */ class MAX5487 { public: