From 5eff4cfe3fda99795c0e64b43fb949c6df627061 Mon Sep 17 00:00:00 2001 From: Christian Zimmermann Date: Sat, 3 Feb 2024 18:35:13 +0100 Subject: [PATCH] improve doxygen setup --- README.md | 4 +++- doc/doxy/Doxyfile | 12 +++++------ doc/doxy/cnorxz_logo_mini.png | Bin 0 -> 5562 bytes doc/doxy/header.html | 36 ++++++++++++++++++++++++++++++++ src/include/ranges/index_base.h | 2 +- 5 files changed, 46 insertions(+), 8 deletions(-) create mode 100644 doc/doxy/cnorxz_logo_mini.png create mode 100644 doc/doxy/header.html diff --git a/README.md b/README.md index 3cfb608..3ff29bd 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,6 @@ -# Container with Native Operation Routines by XZ (CNORXZ) +# Container with Native Operation Routines and Expressions (CNORXZ) + +(as always, the name was there before the acronym) ![Image](./cnorxz_logo.png) diff --git a/doc/doxy/Doxyfile b/doc/doxy/Doxyfile index d54e1f3..38e3958 100644 --- a/doc/doxy/Doxyfile +++ b/doc/doxy/Doxyfile @@ -54,14 +54,14 @@ PROJECT_NUMBER = # for a project that appears at the top of each page and should give viewer a # quick idea about the purpose of the project. Keep the description short. -PROJECT_BRIEF = "Container with Native Operation Routines (by XZ)" +PROJECT_BRIEF = "Container with Native Operation Routines and Expressions" # With the PROJECT_LOGO tag one can specify a logo or an icon that is included # in the documentation. The maximum height of the logo should not exceed 55 # pixels and the maximum width should not exceed 200 pixels. Doxygen will copy # the logo to the output directory. -PROJECT_LOGO = +PROJECT_LOGO = "cnorxz_logo_mini.png" # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) path # into which the generated documentation will be written. If a relative path is @@ -518,7 +518,7 @@ TIMESTAMP = NO # normally produced when WARNINGS is set to YES. # The default value is: NO. -EXTRACT_ALL = NO +EXTRACT_ALL = YES # If the EXTRACT_PRIVATE tag is set to YES, all private members of a class will # be included in the documentation. @@ -542,7 +542,7 @@ EXTRACT_PACKAGE = NO # included in the documentation. # The default value is: NO. -EXTRACT_STATIC = NO +EXTRACT_STATIC = YES # If the EXTRACT_LOCAL_CLASSES tag is set to YES, classes (and structs) defined # locally in source files will be included in the documentation. If set to NO, @@ -1269,7 +1269,7 @@ HTML_FILE_EXTENSION = .html # of the possible markers and block names see the documentation. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_HEADER = +HTML_HEADER = "header.html" # The HTML_FOOTER tag can be used to specify a user-defined HTML footer for each # generated HTML page. If the tag is left blank doxygen will generate a standard @@ -1319,7 +1319,7 @@ HTML_EXTRA_STYLESHEET = # files will be copied as-is; there are no commands or markers available. # This tag requires that the tag GENERATE_HTML is set to YES. -HTML_EXTRA_FILES = +HTML_EXTRA_FILES = "cnorxz_logo_mini.png" # The HTML_COLORSTYLE tag can be used to specify if the generated HTML output # should be rendered with a dark or light theme. diff --git a/doc/doxy/cnorxz_logo_mini.png b/doc/doxy/cnorxz_logo_mini.png new file mode 100644 index 0000000000000000000000000000000000000000..9c974fed5d26b8796ecba50a9a5f682907382f50 GIT binary patch literal 5562 zcmZ{oWl$7Q*T+{tx?7}Ox))Yb1SEE)kre5cbXlYuR;0UGSW=|B79=I4k?!tRkbZe) zo_S~95AVHm@Bhx3^SkHEnLFp)uNrDfMEG?0004jp3X#`(RH^?gTfp(70qaYyJnsHdj`X2R!^|=Cl?iJX-Kv zAO^0F`sn$%PVD7I9uGKhsHy_a4hAL}2|keNTn_-C428<*FB7OY&YX9_vi&H5`>SH#p%HB(6Dj zSM#b&bc?9+{*vSBQ7~@$hKmIV7q5STC5M}zXq%2Gw1aRh-)E%-Bx&VO*n!drldXn| zEw;nu1rzb|Dmll`tF~}o6*zK@xiMr6AxPK81BKHF5oUutoR;9{HRQMUBMm}{9Y6GZ zo@DWUueG8VXIYgQs;|{7-ww#cO^P=<9@qCS|3-YY(?6`Ff9F4g>ChkQN@x*9|imuux~ zagFc(NgUw-O9@478v^6MQLU%-Dc`Q_B)}b+6nm`TEgS7bI8{8 zx4+>x5wE44(_gAmh?~4KKzV>}rD8;03rWtn=0IgF)#I7KuX`*|Hd{kq4U$7MW59ZE z&fb@%IWu`ht}a&1b|G;X<|wwkaTvEJtBfEU^mK#aS|5+v$)WCr*GT^rOT9Zl>&aL(HBcU zvObSIVQ1N~J+?5pJ&EkNTc#At1Bt}Y1E;dg2aqyZmk(-Ig_l&_E$>8>h~qVDE@^5o zsBslbIhEu%gt{^(%K@txKHN9QTC>OePd`L8tZR~L#FkV$W=+&T3(P|$$d`^8^p0FR z7?a~-gSy~2ILsZu#AKdtXqIfmEjL!ss($M5k{@gDTI!wia-lBvm9pzM9)Y5EhIVag z4!I)ny8%*b4ONMXqgB~Qo^l2=wI)@r1|wN+G=Y(sJUobt9Sl6DY!GdW5J+B#kRt~eX-^uJ!uUE~EaGC3klaUpA(4s}my-VWOcp4m z*f6G^V6j@NVy)W_@cqf$uZhW9jbLeybI$8;CC&b0&P`EqgzD6jo9I+*%kfPpv$*Ml z7jxkOS~1F7oWRTF4+Jq94)mdGI)|PVBSu+rq4VEQ_%hOS;5RWK&utEp!6ImYH;{rfU1rs z_Uhv}<}az9O@idAsXF>|v^#GB=Oh8wkN_4Aq=C6|5SlX#%@&s*0I??or;o<=DZ?y} zY4usfFfpanCb^MOa?BI_WUaTRiK?dNACi_Tjh>@iYj? z#dv(raPh-hpRssl@Qjo}59ireVDY8yI(7N8;J;Q!im-@Rz*LOk+JaC9PGPN}dyTf_Edqkg`^Lu1bZ}BH4)#V_OK69*GycTwP z?5!1?#5)?THe?DIO8kAu2W%K0>emVGmd~sd2bCrBS!r5SoaM59Kcv$C z=yl9TCL*zaA}Y@1G}1veECJ}U2W>%42eVDsX3c}1PJUHs3vcE>n{CxgW_|%^{!SZeJYvnX^ zo;IS^-VV-J^Xyz#Ph#c!|9pnhcuWi2f4=%)IwK@m=@{W%o94BeBDBshr+WUq5;E(1 zCJ2r)W7T+TW=>vb4ySvSspjUYI=o4PprA6$Ez12+5sAHj@)Hbj zE3d1mj_k1(3rbg0A5RL?inxCjuu9?97*q#y`e>LT9`<+_oXu+&l4*u2O15v^e!@eU zwJTkZ_t2cXVjEH+ zPp!CsNG_eqQc#5 zR|)}_>lwf{Hx@jRs0AA9WlgTRC%fJyK_ha4dD1+MZbAjr%l+dM!f0>t1!F12^W4SpC9)q`zoHAxLaPKk?Ix-8- zJ~vago#?{gl&y4#oI`Wd(S!AcJ?#Q>UJG}RWMt?2y7NqS`5ka&ebhs&g_5ZmiL2~r z$HQYn>4HaBfv4Tf54(3<7ue4;e5a#0MmRv_c53+&GcPM6e0wj2$EoEaxf5}u2yRP_ znh_bw6{sc6D8$dM>W{IkI2h5yc;2Nq-O?F07rf zY?S`VaR2vTUFL2I+Y{P+&$ho-aut6xDbG-rQxyAnQF~oiSZ^0HKhotE`6SN75$bBk zNm;{S`Pl+duLh%=eHT()!J)%GUJ01!G4I%QrT3b>2_8YjXTlVL<*XCQmc7sCXIkMT zzfuG^diOWCCH;H*w-_PO&RB;l748}aNx!zv?2AX0NAnSEHWyTKc-SRMT;I4itdFtT zc^&CY`;}i*RJD3?43lztF4+R^jYSExSx!~4rL$Q*q-3k-ffIQostY8W{){bnCk7XBr zvX!1CQ`o{-7fhqtZC%qZ+L+`1(B2!Pj z==9}OnJjq%iw$$y#m)2T3j&fXtSC!ebCUu<%rL2*4t)XVvKk(KcfL&xRQcWuk7~SZ&$Nar?H_KQ$(mOPJgywGj z>HGrMySdIa>SM(LJ<4<2rG(nnrMJ6gOv8-~Zo`oG=?eMMP%E`(a(IdZ6x!t_W=4OL z(C?R3ejO3VJ5u)(Crs@Kj$Knm;JocSzQ|;dd4gG|`5wcUkTC+4YooJbU}_Q95}V5? zPT46kVm2FSd|a%IqbPfMPrQB@J|BbwORrH zt6wHrAG?A;hGfrS(=6Nv2bT;S4A51&8k-SkGI@N9#6|rs)xfBO*RH7rqWs%DDZbG| zP16b6XRh%4riV)r0=DjDY#4!6iqgb#ip1)=zOS`rL!_CUB~OXVMJ;l#$vXs0VX9r0a3`h ziKzh97T&ahP9E2P^7jm-P1Rqslkd|n79A;>PIIk*r%B-g+J2-oYRLCDtPRu7h1xv8 zLh?Vo*u@V01p|GXeQVNQ5_$PJe4TtyV(m-8YKcH=s2X-KPy(dFDRYgb5V7!^&hsBm z7H7f9pIHy<T~yoQ6oewaQhdNUNZ{-y*q?QZW^-%bc} zY-#eTIkiIBZ3bDqniaoh59e&-e^7RdFH#wQHDy`ri`r(WXY{b)^$q{!+J)%42wY)uG zdr=tYr_8R?b&r(hu_-RyYdzOI_g8w}y6F* z{KKYE7Xqy3T6shC;mv2o0dlm>B>U2)(MT9o&++A$`s;xJ4`pnyS%rkya}gh%&*ADG zpSs=TD^}dSjobZ_h*Bn?ji6|q3fIHy{VR=4$AieDb^FcBcUA&@g1t0l+`JiCpRP7zO?lxQ^S2;Nd`b-V-iJlMOl#E$(3&d6f7dfJGt312J9ci!9zkmx#>WpFp<+6)nvv;&YAsBQs%4`Lj#(Ovf zRonAdqh(ARm@OXrb5B3khy;gs zT7JEh%zBl%xj42`%3om@5Q0jR_7$}eiVX45qSRmt(pq6X?y#jCLK-H|iUOrIWiLgX zn)=#Xa*!PTljf6D@0#(jDd=2cF6JVv+|b}UBEx~u@<3o{r-0!$++rtJ*t^`PSOmJs zr>k`tO?d~4+Oq?)Lfao1ji$GY1XWof<|pzG=RW&MCgbN@g89AfWiKPb!A}?5hS)Rh zvg#*_!sux`mv`mg$JhSKckE#<8kfy=E@-D^0-{DE*i=jQ{;h-?dN}tJJ>EMyYOO*y z_$}A)`1wBK3VIS_VDf1ER7w&zQrHqbx@!q$oSq^XZIpwpxmsg1WCV&-R&V^ z$9*5-Dx9RyN6(_?H3oiV=p~l2rlks*ixT!}-TWeTd1g;bk@oepxqsjJL)V)W-(;%t zo&-<+ua@m}TM>p#a`!@k#Rg)_*}eYG91?f9{rE49)5?g({}S4_CfaMVOB||I1>E8gi^G77Qn* zgjU@B?X5l93+irc{TPle5ck>Il6>q# zznp%}B%qH1m~;2v;V=T>?0w5d_l!rJvyqNIB*35NYf1@@QeJ0V_qF~UugW@j8{O3S zpr3_?5zusulu+Z3dBw%iEy+$>7oCQWOx?JEy}Ccy;9WW~hf`bn^} zBC{~@e&x4TbYjH^e*q@W#;13VunD^)>**Q40frut8T&%91knJsRD;2%qnKEh!`%;dM`MXp%D|5?gtW80;M}E? znNy)nG6k_fmwZEK=Q6dDAinO%9YQ*DctODLIk-m`LmEW$rsC}C^*s%yk(rb4v=`%t z(`VG;ds~ir@HPlg%ko_l1zQ;1oX1ddC*3qB`VNc~H~M`&bi!oIu)i{q^dM7(d=L$8 z-H=T?R48+`DlGB95bRfjN?xOv1Y5MzhIG&mIIxVxIac**j>kVrHn@U5+|mqgC1C-x zdK3Ui5G2AUD8wfS(gq1h2nkCF3-SmGN(c(3R`GZIAHdPs($3oR{|9ytl6@Zm&i{=7 sw{x^|g_}9L{Fedo2?}cqiAo58C4~MPgxQ0y@R0#P71ZR* + + + + + + +CNORXZ: Container with Native Operation Routines and Expressions (CNORXZ) + + + + + + + + + + + + +
+
+ + + + + + + +
+
CNORXZ +
+
Container with Native Operation Routines and Expressions
+
+
+ diff --git a/src/include/ranges/index_base.h b/src/include/ranges/index_base.h index e13b027..4668af8 100644 --- a/src/include/ranges/index_base.h +++ b/src/include/ranges/index_base.h @@ -28,7 +28,7 @@ namespace CNORXZ all indices are supposed to be derived from the corresponding template instance - Indices are act as iterators over parameter spaces (ranges) and/or + Indices act as iterators over parameter spaces (ranges) and/or the containers (arrays) defined on them Moreover, indices are used to define operations on the