From e0bc9573d4265eeb1c447ace63dabf7b477b5e7a Mon Sep 17 00:00:00 2001 From: Mihai Tudor Panu Date: Wed, 3 Jun 2015 10:33:46 -0700 Subject: [PATCH] docs: updated links to documentation pages from readme.md and for porting example Signed-off-by: Mihai Tudor Panu --- CMakeLists.txt | 3 +++ README.md | 10 ++++++++-- docs/c++.png | Bin 0 -> 1833 bytes docs/max31855.md | 2 +- docs/node.png | Bin 0 -> 3115 bytes docs/python.png | Bin 0 -> 2596 bytes 6 files changed, 12 insertions(+), 3 deletions(-) create mode 100644 docs/c++.png create mode 100644 docs/node.png create mode 100644 docs/python.png diff --git a/CMakeLists.txt b/CMakeLists.txt index e081f1bc..b63c58fe 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -65,6 +65,9 @@ if (BUILDDOC) find_package (Doxygen) if (DOXYGEN_FOUND) configure_file (${CMAKE_CURRENT_SOURCE_DIR}/doxy/Doxyfile.in ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile @ONLY) + configure_file (${CMAKE_CURRENT_SOURCE_DIR}/docs/c++.png ${CMAKE_CURRENT_BINARY_DIR}/html/docs/c++.png COPYONLY) + configure_file (${CMAKE_CURRENT_SOURCE_DIR}/docs/python.png ${CMAKE_CURRENT_BINARY_DIR}/html/docs/python.png COPYONLY) + configure_file (${CMAKE_CURRENT_SOURCE_DIR}/docs/node.png ${CMAKE_CURRENT_BINARY_DIR}/html/docs/node.png COPYONLY) add_custom_target (doc ${DOXYGEN_EXECUTABLE} ${CMAKE_CURRENT_BINARY_DIR}/Doxyfile WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} diff --git a/README.md b/README.md index 514c384c..76acd9fb 100644 --- a/README.md +++ b/README.md @@ -57,10 +57,16 @@ Make sure you add yourself as an author on every new code file submitted. If you are providing a fix with significant changes, feel free to add yourself as a contributor. Signing-off your commits is mandatory. -C/C++ API Documentation +API Documentation ============== -The C/C++ documentation is available [here](http://iotdk.intel.com/docs/master/upm/). +@htmlonly + + + + + +@endhtmlonly Version @ref changelog [here](docs/changelog.md). diff --git a/docs/c++.png b/docs/c++.png new file mode 100644 index 0000000000000000000000000000000000000000..b2beb322a997104b9c2c209496bd22b43e0e50a4 GIT binary patch literal 1833 zcmV+^2iEwBP)#2AMrg*VbR#2AMrV;&M!Xd>nzQANx{qKv4YLn^Y9$eowKwf-U6Ke-xdbHYwk zud=Kr9dB-~MX!tF%Jn{uz56cKtS2LFR#}E*A;8OBu5_RNc{vQn+bD~ZosM0b}$^M+rsW}zLo+l_tn4oY0$u=C84YyhN` zG&MD0%~^^R-jH>dWhV3c7gquB)y+HU8nvUSaZ|P>Sou&1%PQ;H>O6n=^y$+yHa3z{ z{Q?R3HU4x%N)9K7z09rs4vNmicsuga>=b4=0O;uGpu4-91xq#|ga}#p*bON_--m}8 zN?naHX~C3j306K-!r~#7`KkW!;lqb9BrU+2TgCnAiqEQ?l)iRZu0QN@xiF^WpqXt* z;SE_gQcQ???^|}p@*$#0IlCUBD3F>M?~h-&Z~@Ewa)PPnnY%y8$jAuI&CSH;)*+>s z72T6$rFdZZVC6$))`u*sNsp>3{@3z0ZPx64BZQPl*d|dHbboTU#)y|l(OzQu> zbd{AAzGdtB_3PPv^ruMY!iSbyxhM-;yb*vSM~-lNM39(T6yO2D>UQ7q@J`1KhI%do zlIq)Y*m^hb;K74j7_gw3ZN7x8r|{@gc&DR#+VY0v>{*@U!?H0v+Hv0h(#p!p*u1Wq zKYZf#Z}b3+dW~5s?LNZXBhw{XGVan zrnFM@iGe*_fuQ7P^Bsoeg6c^7f7tZ3Qi^hXW9!b>e$MK@pW(!(ZbnAE zj)j9wZ!=`f#u{&?Zjo_W%b#S`@<6$fkrA%^^C(*7cWJ1rz^M1VxB~|cAT<-Zq^wE3 zZzj4m%e^zN8}0!v^;~7t(@$@2FIeOQdw8(&p`wm$bY}bMywXSA%e#4F&tBYacR;11 zqoW)@ew@0xI{I&YfuiYnwzkBd?{c{?rj>w{v!Z)^*-M|_pz7PNQ(C!#%Y7b{yDPY< zo?zueeU#*hT@n#E2Zjz;;DS ziMjg4ZNTe*_K-p`!ox7|{VzNA?p4Mv@l9157Xv>8s)5IAd;9p(4YUK>hfcluDZu{$ XZ~k=QOCttB00000NkvXXu0mjfvXiL* literal 0 HcmV?d00001 diff --git a/docs/max31855.md b/docs/max31855.md index 04706024..7405989e 100644 --- a/docs/max31855.md +++ b/docs/max31855.md @@ -80,7 +80,7 @@ useful to us and converting it to a double. Our final example, very easy to use API! -@snippet examples/max31855.cxx Interesting +@snippet examples/c++/max31855.cxx Interesting ### Building diff --git a/docs/node.png b/docs/node.png new file mode 100644 index 0000000000000000000000000000000000000000..f0914681712c206a46adfb7ab39767c2ca6717fa GIT binary patch literal 3115 zcmV+`4Ak?9P)=p~%Q7z< zcRzJ zi9>ai>xB^MBP~T7sv}1)gf!AZ#Bm*<7eb7*3~^is=%x6K9hHdB*inkOVMi%Oy(>2A z&15^qB7~sXU5_M>Zha%TE;BaC?7(77KoSye@1CRYZ0pGcG0~(D6fJ>fsezJcfeW9Kxx@A-Tn$j=K1>n(_?nO%QsVc{C zII`yy&4#lS&$~hOZ?7nOfV|W~0Dkz|Mq2vo&}hSbFfn@?UzxH3yCpfQjX&t)jbkr! zwCRBA@@Rz+s97A=6ve0jY4!|m43^W~>5Zb(YP1T?>zm)>N~=dzIU*%;dKG~rsn0_Q z5vB9HRmVAdvu1!)twyKHroQ6n;$jTSP4I5 zQFKH4oBn=DRXGOuL^G0wd|mhq@w|jW;razP-Kh-Xs;VkdQc|#3EXEI2YNW3H6yh2IP?Fg}k!u=>W;-3-t(V!=N+L)z?W) zYc)N7&u7znh(7XFJ~_^OrEc@)&7@DTG3V~t=uLXwY5X-OtIlDunPPPRyih%O5`#K& z=gyt1Tel8_!N9U*%lP@L+Ys4T`NhnnunPf5wPmuh`~mXP3S++C;l9YuLqDS7%9*J8 z8ToUln6(O{-lWtuwKs6t*A~r3mK8o@9Ao+0IS-R*cSX?z`-8l3_?NtQ{_Rh%_>dVJ zHmrym=*yQc=ZxtPMymmUw0sA*emi^yqqZHiLWF0ET16ftU`Iy>d*9uoJU{ezkI+)v z9;O>QlSFugTMY?3wCG92sC|8X)YR1A^M!+}^yEzLowJtycCErQ%bvqGZ@xdur~o+` zxlGBM6;&6RNeRY8RxjK@rrm`s%k15|m#V5N+-^5UgORV6e~aWRd7obIp&sa}K4;r& zl)5LLc!GOx{YSDKV^!_*;fnfe?4S{9Fc^6G?QI16!y$cnc{z!fUBj+@k{oV-Tgh_l zRwn?54jsbfa#1q5n4%dIsIIOCz-F^CC21b+_8uf5m_P9jwAyeAbM)v@GBYztNl9VH zjvX;0S;*lvc45(-*vxhSDl02lx^yXz{ouQN{r^I{UDkU^2(&^D8$+!!*kBrshL(#>>_0K!(jKXNl=|bX z$V7LBe6{_wymF;(_3G6aobdI3Ucme{CA@Rt73JNcg||`t+d70Sn2=;Nl6K3{?PiF^&ZTp zrK^z*FF(ksQ>UWdPb!$s_m(_MQSvNR`#(}t51t0kSO~kM|EPI|**7gB!ID66aWPrJ z@iA+P5CW?)0lPJv7WjNVjvYJ39qY?6Sab*>(b!$5(C6mn()3XWCcPP(ISB~6?ITBy z@a1(kW47r52->29AXyd|bw-?tX+U`J9XxoD)I2+pj3v|IQr_u;CIWo{3}*c&XnyS= z&8=x={jR?!wX=}QRS!~9QUZiM+NvdM_?v$^grz{`;AuEF@_8U)qEMNxJ~zLsewDk* zRsitu{okdby$)_1pp#^QNpDe}ySlp28MGwl*c4ai4S1FJTCJ8~w}eh(Q0hD$4?3e3 zXKs?xW;l6_gZLPYMoLRdhtsY7fYE9eUh?1Fhb9wtwo zJghDrkB9DF4|wi+2F<4G?W(1CDEM3e>Wbc-P0098CgOAu3Wi-Hbcg!GczH( zgyR=Ji1~6(UbgbPrKJU5cRLfR{fHg~=;#~6?{#gHeTHTEZSumquHWOV_ z6?t~=-i;;8sIFnvKDLVqiey2Aha@CkJ-UO+#g9eN$g-@^{pN!gnUpn)RA(A4my72f z*c!uQ_wL>7+O>v==FzPet~No1+Hih6~U%Wn>cae1h*}oikh}i{Sd%6D8T9J>QZJ%q`X)AJKlcp z-<1Jy;lc%)o12xL8h7ty)>hraTW`Oq^e2yop z*3jD8s?hfL_p@co7H(g>git61fY<9q7V-d}m+xWETW=_QbUHm6jRskksjjZ(U!VOM z?R8xUA*gLRK}ZUJXaD~F_&h=C+M-jK!-o%3QBi?&Y$6tik@M}Rd13d{oH-M{O9pWI z^l4VET*>zS~?Mba3ns&>%a^;}u(uKnkP`>dbCRdw|C_A>2j1?0_)zTqm%GRJn+ zbMd4Hzu%8F*~G#}CZRVCoRfO5_&N7ZCk{CSi^am_%a^IGtwnFva>JZ4jGv#ati2Ij zI@68+BMW-jNNsH`?k+cZrRfwe%IDn|YVdS| zckUb>j|Y2}m7=A&WR4H-Z+jahPQ8ASrp6|+N}SAEF^&swdeQqVw6(R-*w{#NP9mi% z3Q2Gd1c&DjU8MJnhSbCibUGak4GlCkHIbNRX8eL|a;K|*16XtC4@y-xEI=qIflQRK zhC&uHLXy!LwAZBR_lM}coXbtC|Qolfi1P06S z`DiF0(R0a9C?H`l=}1U14NDvJg$Vg2EDodMvb~*t0^Sg2n*nRGDW**XK2MN7cK}%i zYqAlmJ7n(0`o^f3a8^_2Zeqnr+B7RG8lw#E1QvCml_>3K;&;SOQ!-IgH~k2|?f~jV#N|UiXFX0Z#*;bebH;pErWQg9kR9 z-=c|}SC+5Mn+`k-lmodR(>RVlKQsUbfT!Mn=E7-!{{`t^ytj+z!TtaM002ovPDHLk FV1mUD0LB0S literal 0 HcmV?d00001 diff --git a/docs/python.png b/docs/python.png new file mode 100644 index 0000000000000000000000000000000000000000..3624457e943805d10950535951893f5d377a0e44 GIT binary patch literal 2596 zcmV+<3fuLGP)wl--%FGU6!WQUnDn@=FT12vVU?P$+HFHcgr~P43%2Dz8mbw1tN)PQEjD zChwkm&iCAR-#z!ddtW3)Q2_Y->9?i>i-8e9emE%^<{{lc#6onm6y}1fl z)~l{X&>bxM?W+4+;@x4ns=TL=Q9^&%)1^|mJwbQ?P03B3^F#@_ZMf*xUv zUWi~)Z+j6zkC3VtLDAbzM9@R%g@_E=wT8${y9S{bBG}tLM9@P-!s9iFUsZTCn4+;| zI8cP3w)}g7{?^`h>8e2UnP#?G(3_&wYefkB9v>}@O`7s_g^Vc$44p9+fK9Ldo5nB7 zF&d(-I`1zHO=ns{rjwihJReDt!emW#ZqDpJ%8`vbX>Dq`Yz|45&>N!&`21Yl>{ij? za@%+NsXKn0X*q?L&DB?-X(D2>#dJAf0A{O&>}jL040rPBb8jJeE+ceFF!S}NFc_n7 zpReV^$6iL3WmT*wp%0)CL4J*imMnxotD=bZM}6PEeH0cJGGW35mM>q9*Xsq~x>N`H ziG!%|)c4%J0tRDSxN9}Q%OG_wm~V_Go3`mnh7-fsjsZ! z{E-TjPWLF#Cn}tZ?#%E zc>X&^%$dx>AgN0T>eA^@)}_!IM1{((4${bzZ!f-HhTv?@xcK~oe(m6>f8wch1&;r07Cz4wS( z=NvnXt>ydF_O?MO^h<~XptQ7Xg7&c>^TEBh!cKR8NoZ9s@K2O`LKz@EcRYsp`D{a(JwS94MG0!bo&Rt`t zsC9L9b!28{l9`#wk|j&fNpcwfnl)=kO--e!s7PH?zE23KJX#i65dzIhht3Qe zHjLG4{?6p5?_<{MeO0D{3F z8#ZhpCnkkSu{mm6Ap}31KEnd%c$VEbi{A~M5W>H1-8vR6T118}fe9_C9RB1>Rpv-f z*u<4>v-_thr8stF4e&| z7b>*7zdsgP1O-}^j@e^!ax%Bix{I`tLovn0sIz0{%$Xc2JIK_51&E-aykwuMGiS~m zcAxzQOG+Z~&bDK|9Xob#q3QzpNf{VrL&!{$kVrJfk!Xw~O45h$A3Ai1LdQ_%44FiH zR6h*vfGRT@jZ}N;iHb2{wzkbOpU=mE0|%I$GXawvg$N4V$A3_D($mxVUv))TKYxy= z#@nFT{k>SOS|Z|dxhN|uqq(`6s;VmX?Ab$caWSplW)|j6#~Eu!2*J4{C#kOd0ee~s z85tP_9Q{Zy9Io0aE-og^<{-vk3QKf4b9N4oj+jJM-Z4v-Bnf{o5VCVqUtfb1>g!)!2y*fYnsCr@s-8^7OAYoN8qJX+pk&^YDq+!<$VB9Dx?BdlF#&ZAp)GjhRn zWLak3ym`dO#{;l!+csRawd7_GY}4sr-)uIkiO!|?6{TI?mCWmM(^TJxIX;%?=x9cd zA48xui2UQOPWq_!8NX-G9*jBzGE$Fuw4Q02W{;w)na~Zr#tSYg_P3?~7Y7V}42|&) z%=&2ciEZ(;g)EcF#FI}gCADA(jvKPN&R#q0h+Il`V&_4%?jLWiMai%d)89tcEd|`P z@J>~>cI{fyE&VT>r|<5Fh_2q#x@Z6R$9ow(@_O~!@AtED<3^_1^FnM?>^e-&t)l>V z=GkWf*t_{NN=ix?B|3+#c7Ej&vM<+ufTM5-HhUsYr;|tDcs|Ux4I4I4TwKh&?3=?9 zk?!(n3HjotsurcW(W^dbE|&|S+q&hS?WeA)Ms=*Dq=d!>H^Z%|A?K=PuDU}O&xDP@GKvFxQSq=wWqeWmK7^jFnjiFauWuS zmoT8s)@AT$S)><7E$9@}t_&x97x+)*7u46+lWQBm+{}sH*1h}X#~C=XZ5^3AcP?LT z`i%RtCx^9b@O#D>$ zRJjk2$HQF%3c0C&`+J|OrIAl+k3ez^CX@3{48cC99Zf+(iDT$)QJn|CqzkL-jtn45(&I4O+A9<#Ji*d{ z=St9Lz7ZK-G)Dcse*Jo~EDj9lG+)Gj4d^qU(EV%S^Ss}1h>GtkDK9T)PWo8-if?@l z(lf*E(R@w2TvWHXX$rIuqc@Te9oyUP^jY+&?;aBjF(eq;5{ka$S6_o(2vJ4k@4D9# zPU}T5xF49_+nz+wZG5g5Li`0N0=j+~iJ&jR53H0FMPb>1+m-^)1NvTeDuPSH4?OzU zQ=49sF76dBO)L5huml(br2m9+1ivg!1D^vcS66QS7U2JDp)TN^iS&&C0000