From 4e8b9ef301a31214144f9faffa611f2337def88a Mon Sep 17 00:00:00 2001 From: Andrew Belt Date: Sat, 25 Sep 2021 05:56:18 -0400 Subject: [PATCH] Improve namespace documentation. --- docs/index.md | 5 ++--- docs/logo.png | Bin 1536 -> 1807 bytes include/app/common.hpp | 2 +- include/asset.hpp | 2 ++ include/audio.hpp | 2 +- include/common.hpp | 7 +++++-- include/componentlibrary.hpp | 9 ++------- include/context.hpp | 3 ++- include/discord.hpp | 2 +- include/dsp/common.hpp | 2 +- include/engine/Engine.hpp | 2 ++ include/history.hpp | 3 ++- include/library.hpp | 2 +- include/logger.hpp | 2 +- include/math.hpp | 2 +- include/midi.hpp | 2 +- include/network.hpp | 2 +- include/plugin.hpp | 2 +- include/random.hpp | 4 ++-- include/settings.hpp | 3 ++- include/simd/vector.hpp | 3 ++- include/system.hpp | 2 +- include/tag.hpp | 2 ++ include/ui/common.hpp | 2 +- include/widget/Widget.hpp | 5 +++-- 25 files changed, 40 insertions(+), 32 deletions(-) diff --git a/docs/index.md b/docs/index.md index 5a619343..b6748eb5 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,3 +1,2 @@ -This documentation is generated by Doxygen from docstrings in header files and might not include certain functions, macros, and structures that are present in header files. - -It is highly recommended to instead refer to the header files themselves as a true reference. +This documentation is generated by [Doxygen](https://www.doxygen.nl/index.html) as a convenience to Rack plugin developers and might not include certain functions, macros, and structures that are present in header files. +It is therefore recommended to refer to Rack's header files as a true reference. diff --git a/docs/logo.png b/docs/logo.png index fbb959215885e207c51eee396450df3f08e704e0..3291b8bc5755b9d0676c72fd7c5ca93164965ce1 100644 GIT binary patch delta 1768 zcmVENG|k#b%R3u zNXZW5M!i!+Okww?CGBP~k%ESx#-iDXS_L%(BD>U?e3))BV~v?Sy?8U4n9RKAyqTG0 z|L_nd^PFd%-+SKkeH>(7Yk}W?0G|M5KsoRc-~mG29uMMjEsyBiA1<}?;baA-eh88LN`2^ zL(Uh#H+Bl|!feROPt@o0$&n*Rq_3|}5{ZPUD3M4=e}BImK73d_9*=GfPGdG1Ep5hp zx0Qax?RHCZbF++%jVS?trP8ZcucWoLRTpv+a~7l|1G86B3chRCE*TmcS{BrY8X6js zy1F_Yzz2X!1umo#(BW{%>C>l`Uq3r)X=%{`{Mrhv0)?J&<;s=P-rk-ysQId|uUCb8 zgT+k7a!TcJIONKeD>(rZ5xIKxs!r`)O9l3+N`R9mPv#6v#B6_m8gK&aTnet!s$d`x z$Z8u~N&^D}x^UkmfmY7_-2~L9s!{-_)5*n)7s<=h8_yp+ctCe|H!ohiV03g8kHx8?*mI-fS}Y~Ss6OEel)f|{C|lD&KPY9&)sQzHWd1Mgxa5((+( z=#cg6*V_RT%xwz*3b9y8A3AhM2`mpfofzNH7=_uh+ZWSe0+St z=c1w_tt{59Tc_o(D0d$4I-SSs*J-~7ps=uT!RL{Y5v?pDk%*SRqT+eLR5}lp&70!l z;su{?-@dK%PypibIDLJ6O1_$!%){bjWpHrNGD>}a{lYo-)YKH`&!1Py;M}=$#9}ce zUrmhybdaXksjI6~>h-p7-@c%nVHlP(n;SQ7$f{MVvNaU^6%=MD)6>(Ia9v$pi^>{? zA)!!6VzJnw?!UFQHJf0<+ze%}mE-m6*OhATz<~oxmiKr(vU~S#X=rGW+S=M|jcXs; z??GXIRdDd&K_$3&JT6sLRkjlVvY;2*r#;4T=MeeOJ%_Q`}b=l z69@$4(W6K2V$9CYN;n*rjT<-Gg}cW*S+2y79zCiAmsB_$maSX2TGmv1dwa^2`19w_ zB|ksk4&0aU{vc!%Fbu39g$%>s;lqcNm6fG`a#>Q3A3vtMyPM(RVIq+TKA(@$(o+0> zKUGy#I2`HEVp>{SXl`!S`N>(Jn0b3BVD1{FeIkCpUuI@zv}$m+gSO=^t6&RT3-v6@-vSP)GoB;-dK~*q+ z%d-Non6b>S!4oG=WVH>RI(15?)>^H=z&xM(UNvY#zIi+zX>4qi-rip2*L7xQ zM(*6XBaMxXx=@07mKaP0khR+k1qB6v?`|`cmzR^DpO44mVPax}Xf#SR8s+ZYyWF~U zi^<7J-SA)z)}I64+9{mWFZLdas)A^=!7SSZusc&=NfiVC`kBGL$L#E~A}8iJsCD@! z1NH`U9Lw6Rz4`hWg{fMGtP2}meI`_iISZfBNLIyW=HjND1m{wlFpp~cv415$IDxr> z{u0=jiKMK?IXn7@_qWr_F(>1Nm}e5n+v!ul7>jSGk1q~qU;hVT0`Jecp9~2A0000< KMNUMnLSTZ=f?Tu! delta 1494 zcmV;{1u6QE4uA}h8Gi%-0008g8qELz00d`2O+f$vv5yP zfP?@5`Tzg`fam}Kbua(`>RI+y?e7jT@qQ9J+u00Lr5M??VshmXv^00009a7bBm z00DXQ00DXQ0YY%d&Hw-a2XskIMF-;n76KPC+Q#Dt000EeNq8Xp=< zA~tGB(=-&+#8&V@6k1c%rL_hNERZf}+2!v83*DKy!^~37eVEMLGv|NLz31zm5W%RB zO;oUr&8($}e1CFCF-4p!T%en7E;12BOvslbLOGA|C|f8dY~)BWLO*9{=VxvNT)vU= zsiT!)6le_7$}aL32Nj}*HWC4$=Efv#)L>-`wwfp-SwhW?5e~CD8?Y+676~;sy4VqP z6B~)$BA5_^H2NE&MKf_fQDH?CR>%)9PP6kALyos5-hX4cmzkDvKbt9~h+LA4afJ)? za*69+i@(k*e2l!N8@)7Jua|U6LrTd`GaA-ey{db?HEi@YkU`Tgcj=&h)4~)}R2$5I zF{;d_Z?Hy7d)1?0)Td{ZYqnCCTZD+Z84L8LCIW&<(v;p-o(b@<(`0JgPQ6ksuCww7 ze9G+jHGg)aYjbPXk|oqEePQ0vw#-<%%NZLj9m-m>S^7yuCb$H3b6^o#ozr_XzMxR= zrF5ylY@sKJKp5D{!}fz*!vPA7z7nUKbNo(%eAZFPcJ6d=bdoT;*&~$G18~r}lGlyv zzOGMHrTh%OJZ;m58q47MLF>GO+5vz<&e}hhs(;@AHmIkKMqsH<9U9la`bWpLWuX|_ zK_OH!WdHnvW(;6E7Z9{U+qF~WW}mw`hNuiv!R?t_oX2ig-k4-Rr|08A8RZl+N-qQH z=sV7N0#Gp(aMZqrP5R5F+h>ZTXICkzn5HF7E2hI*<(Gu)<0yP@|5UGO2iTaZ=fO@o z=6_CR2lyS%%QsvjL79BphcTINYeq@AkU%3$vmT>|^9;<_ zDwW*f;CN@YMsU*zwX?N~p%U9|t3cf3U5S0Gnu~crVhQVd%RpbPJ{i-?9{~j-kpc_^PPtX)9KE`FI@7vg!pzIz@o{&uYZ!GT!sBJ zK%Ax^-LZxx=^DlC+qe)_(RqttUET&_qE)xl@r!2H@tZxx#q={1v{4tk8@%v zyR}Qvi%v31A7^N%*RK~HRBi80dp|wFJMI4ijr8|d(8_Gr0000bbVXQnWMOn=I%9HW zVRU5xGB7bYEif@HGBQ*!H$gfwGdeXeEig4YFfcbGF(Lo}03~!qSaf7zbY(hiZ)9m^ wc>ppnF*z+TF)cDOR4_L>GBY|gFfA}OIxsLseu` functions and types +/** Extends `` with extra functions and types */ namespace math { diff --git a/include/midi.hpp b/include/midi.hpp index 769ab766..67421630 100644 --- a/include/midi.hpp +++ b/include/midi.hpp @@ -11,7 +11,7 @@ namespace rack { -/** MIDI driver +/** Abstraction for all MIDI drivers in Rack */ namespace midi { diff --git a/include/network.hpp b/include/network.hpp index 1d613f1f..07fc2684 100644 --- a/include/network.hpp +++ b/include/network.hpp @@ -9,7 +9,7 @@ namespace rack { -/** Networking functions for HTTP requests, URLs, and downloads +/** Networking functions for HTTP requests, downloads, and URLs */ namespace network { diff --git a/include/plugin.hpp b/include/plugin.hpp index 34fb71b2..81365661 100644 --- a/include/plugin.hpp +++ b/include/plugin.hpp @@ -9,7 +9,7 @@ namespace rack { -/** Loads and manages plugins +/** Loads and manages Rack plugins */ namespace plugin { diff --git a/include/random.hpp b/include/random.hpp index 2af5e2da..0108051b 100644 --- a/include/random.hpp +++ b/include/random.hpp @@ -7,7 +7,7 @@ namespace rack { -/** Random number generator +/** Random number generation */ namespace random { @@ -86,7 +86,7 @@ struct Xoroshiro128Plus { }; -// Easy random API +// Simple random API /** Initializes the thread-local RNG state. Must call when creating a thread, otherwise random state is undefined (might always return 0). diff --git a/include/settings.hpp b/include/settings.hpp index e7b5b1f8..6e558ad6 100644 --- a/include/settings.hpp +++ b/include/settings.hpp @@ -15,7 +15,8 @@ namespace rack { -/** Process-level globals. */ +/** Process-scope globals, most of which are persisted to a file +*/ namespace settings { diff --git a/include/simd/vector.hpp b/include/simd/vector.hpp index 989b65b2..9d255669 100644 --- a/include/simd/vector.hpp +++ b/include/simd/vector.hpp @@ -6,7 +6,8 @@ namespace rack { -/** Abstraction of byte-aligned values for SIMD CPU acceleration. */ +/** Abstraction of aligned types for SIMD computation +*/ namespace simd { diff --git a/include/system.hpp b/include/system.hpp index 5f01d76b..47bfb75b 100644 --- a/include/system.hpp +++ b/include/system.hpp @@ -7,7 +7,7 @@ namespace rack { -/** Cross-platform functions for operating systems routines +/** Cross-platform functions for operating system, file path, and filesystem routines */ namespace system { diff --git a/include/tag.hpp b/include/tag.hpp index 4431dc4f..411fb43d 100644 --- a/include/tag.hpp +++ b/include/tag.hpp @@ -5,6 +5,8 @@ namespace rack { +/** Tags describing the functions of modules +*/ namespace tag { diff --git a/include/ui/common.hpp b/include/ui/common.hpp index 349aff1f..c07557ba 100644 --- a/include/ui/common.hpp +++ b/include/ui/common.hpp @@ -16,7 +16,7 @@ namespace rack { -/** General user interface widgets using Blendish +/** Common graphical user interface widgets */ namespace ui { diff --git a/include/widget/Widget.hpp b/include/widget/Widget.hpp index e51f9529..6de5ec71 100644 --- a/include/widget/Widget.hpp +++ b/include/widget/Widget.hpp @@ -12,7 +12,7 @@ namespace rack { -/** General UI widgets +/** Basic UI widget types */ namespace widget { @@ -494,7 +494,7 @@ struct Widget : WeakBase { } // namespace widget /** Deprecated Rack v1 event namespace. -Use `FooEvent` (defined in widget::Widget) instead of `event::Foo` in new code. +Use events defined in the widget::Widget class instead of this `event::` namespace in new code. */ namespace event { using Base = widget::BaseEvent; @@ -533,4 +533,5 @@ using Show = widget::Widget::ShowEvent; using Hide = widget::Widget::HideEvent; } + } // namespace rack