From e586e156b5db26ae59d550943e64fd505304718a Mon Sep 17 00:00:00 2001 From: Colin Clark Date: Wed, 13 Dec 2023 11:06:28 +0000 Subject: [PATCH] Additional documentation for developers Mostly to describe the source of non-standard icons. --- DEVELOPER-NOTES.md | 45 +++++++++++++++++++++++++++ doc/images/gq-marker.png | Bin 0 -> 518 bytes doc/images/image-osd-color.png | Bin 0 -> 529 bytes doc/images/image-osd-first.png | Bin 0 -> 508 bytes doc/images/image-osd-icon.png | Bin 0 -> 412 bytes doc/images/image-osd-last.png | Bin 0 -> 517 bytes doc/images/image-osd-rotate-auto.png | Bin 0 -> 522 bytes scripts/doxygen.sh | 3 +- src/image-overlay.cc | 17 ++++++++++ 9 files changed, 64 insertions(+), 1 deletion(-) create mode 100644 DEVELOPER-NOTES.md create mode 100644 doc/images/gq-marker.png create mode 100644 doc/images/image-osd-color.png create mode 100644 doc/images/image-osd-first.png create mode 100644 doc/images/image-osd-icon.png create mode 100644 doc/images/image-osd-last.png create mode 100644 doc/images/image-osd-rotate-auto.png diff --git a/DEVELOPER-NOTES.md b/DEVELOPER-NOTES.md new file mode 100644 index 00000000..a78d3247 --- /dev/null +++ b/DEVELOPER-NOTES.md @@ -0,0 +1,45 @@ +# Additional Information for Developers + + +## Non-standard icons + +#### Collection drag-drop icon + +#### ![][image_ref_gq_marker_png] +Used when dropping images onto a Collection. +Defined in `./src/icons/gq-marker.xpm`. + +#### Overlay Screen Display icons + +##### ![][image_ref_image_osd_color_png] IMAGE_OSD_COLOR +##### ![][image_ref_image_osd_first_png] IMAGE_OSD_FIRST +##### ![][image_ref_image_osd_icon_png] IMAGE_OSD_ICON +##### ![][image_ref_image_osd_last_png] IMAGE_OSD_LAST +##### ![][image_ref_image_osd_rotate_auto_png] IMAGE_OSD_ROTATE_AUTO + +Shown in the Overlay Screen Display. Defined in `./src/image-overlay.cc image_osd_icon_pixbuf()`. + +## Menus + +Menu processing is in `./src/layout-util.cc menu_entries[]`. + +## Doxygen Documentation +Complete code documentation in html format can be generated via the script `./scripts/doxygen.sh`. + +[image_ref_image_osd_color_png]: +data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAC8AAAA4CAMAAABaKlG9AAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAAaVBMVEUAAAAMDAwlJSUyMjJwcHCWlpbIyMjIu7vIoqLIlpbIV1fIMjLIAAC7opaiVzKWMgCiu5ZXojIylgCWyJYyyDIAyACWu6IyolcAljKWorsyV6IAMpaWlsgyMsgAAMiioshXV8i7u8j///+Wu6iCAAAAAWJLR0QiXWVcrAAAAAd0SU1FB+cMCxA4MY8D9CsAAAAQY2FOdgAAAGAAAABNAAAAEgAAAAaBW3h1AAAAiUlEQVRIx+3WwRaCIBSE4StIgqRpmqZB6Pu/ZMu7a8Ad5/Ct//0MUe4qIaOJikjUKlotiKS6RVPyWt9oA+mGe91aqNXcG3uHrCl9rn3XP6C+434Yn9A4cD/NL2ieSp9rv6xvaF243/YPtG/cO/+FvCt9rn04PHQE7s/goHBe39OUPvUPpP6N4p8ff3aBez1VWm4AAAAldEVYdGRhdGU6Y3JlYXRlADIwMjMtMTItMTFUMTY6NTY6MzcrMDA6MDAHcncUAAAAJXRFWHRkYXRlOm1vZGlmeQAyMDIzLTEyLTExVDE2OjQ2OjEzKzAwOjAwAcszBgAAAABJRU5ErkJggg== + +[image_ref_gq_marker_png]: +data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABoAAAAgAgMAAABxxYCWAAAAIGNIUk0AAHomAACAhAAA+gAAAIDoAAB1MAAA6mAAADqYAAAXcJy6UTwAAAAMUExURQAAAAAAAP8AAP///9GTukgAAAABdFJOUwBA5thmAAAAAWJLR0QDEQxM8gAAAAd0SU1FB+cMDBAmAeBMw+EAAAABb3JOVAHPoneaAAAAJXRFWHRkYXRlOmNyZWF0ZQAyMDIzLTEyLTEyVDE2OjM3OjU5KzAwOjAwv50QQQAAACV0RVh0ZGF0ZTptb2RpZnkAMjAyMy0xMi0xMlQxNjozNzo1OCswMDowMGi3o0kAAAAodEVYdGRhdGU6dGltZXN0YW1wADIwMjMtMTItMTJUMTY6Mzg6MDErMDA6MDAT0ZKsAAAAWmVYSWZNTQAqAAAACAAFARIAAwAAAAEAAQAAARoABQAAAAEAAABKARsABQAAAAEAAABSASgAAwAAAAEAAgAAAhMAAwAAAAEAAQAAAAAAAAAAAEgAAAABAAAASAAAAAEfUvc0AAAAU0lEQVQI12NgYGAMYQADxiUU0QFAOgBIpzAuYZwApDMZl7CB6CzHJVJAOjRr4pKsqQEMWauWLl21agKQXrkMQkP4MHmYerh+mHkw8yl1J4IG+RsAUr4r6YrrTcAAAAAASUVORK5CYII= + +[image_ref_image_osd_icon_png]: +data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADEAAAA3CAAAAACArv3dAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAAAmJLR0QA/4ePzL8AAAAHdElNRQfnDAsQHzbLotPtAAAAEGNhTnYAAACxAAAAwgAAAC0AAACFGwGBxQAAAIhJREFUSMftlsENgCAQBEfDEwqgACzANqjXBizAAqAACoACfPhFc5roA7n3TrJ7l2wO2phBWyMW51RAWT+JibBEUGaa5Y5WYLydQ5365SRhlUhLBJyXEyVuAKXq6n6OTnSiE+0T1S7RDsBpOWH90XBywlzVfe/dN4lWbv7JrnKQi0PmySfz39kB1uwlKlcOPpIAAAAldEVYdGRhdGU6Y3JlYXRlADIwMjMtMTItMTFUMTY6MzA6NDQrMDA6MDDZ9N6UAAAAJXRFWHRkYXRlOm1vZGlmeQAyMDIzLTEyLTExVDE2OjMwOjQ0KzAwOjAwqKlmKAAAAABJRU5ErkJggg== + +[image_ref_image_osd_rotate_auto_png]: +data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADEAAAA1CAAAAADNZlzWAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAAAmJLR0QA/4ePzL8AAAAHdElNRQfnDAsRBQsiJQ8QAAAAEGNhTnYAAABCAAAASgAAAAkAAAAHVi99BwAAAPZJREFUSMfdlsENwyAMRX8rjjCAB0gGYA3mZYEO0AFgAAaAAXpooibBAlNVVRSfebzYsZ0A14ibJiM+nFMBFLlZTAQfAWVmK3+iB4D7cB7/IFSrMuDq2CCShxsjSszEWJp5JO/TiAMoEbWlUyvGotoEY+m+j8qigKUnqwiZtaj3PZEhclotyR2JEp/yXER9tcvlp534CXKWOOI48WsFNVm7mWy1vWk/8WGp4M6wI6qJfzAGQR4HQ5eoDF2iMnQIxtAhGEOT0BMss2EbBDkQhgjDL/1z7t2rEAoA9AQAk5YT5AoATXLCyD/pp61VDvLDIeObP5lzxgsCJ0kQ/qcmPwAAACV0RVh0ZGF0ZTpjcmVhdGUAMjAyMy0xMi0xMVQxNzowMjo1NCswMDowMFXfsbMAAAAldEVYdGRhdGU6bW9kaWZ5ADIwMjMtMTItMTFUMTY6NDU6MjMrMDA6MDBkc4/mAAAAAElFTkSuQmCC + +[image_ref_image_osd_first_png]: +data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADEAAAAyCAAAAADQY2xuAAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAAAmJLR0QA/4ePzL8AAAAHdElNRQfnDAsRAzW1HrU9AAAAEGNhTnYAAABCAAAARQAAAAkAAAAFZ5jT+gAAAOhJREFUSMftls3NwyAMQF8rH8kADJAO0DUyLwt0gAwQBvAAZIAeKvpDTSA9fOon1acg8/RswFJgbxycH7o3J11B/HTqJpYQQYbTub+iC3Dc3Yfc62vEvV8B0BCbxDg9E2uc29XkMvb38ReEGKdB0rVY2cTj9pcQi5VN5NtPWjgvtapyaJgVNOhkvtE3Iuk8R2CNeKx3Lbbh9mVaxDZQt0jNULVIzfCwbBGvhmzZrmpoD/0L4af3yXI+bhAdhm+djx/xI/4rIQBuBBidvaXICuT5dt4miqxAa76L7Ad9pKV/85L45E/mO+MK4dVZDcfYdcQAAAAldEVYdGRhdGU6Y3JlYXRlADIwMjMtMTItMTFUMTc6MDI6MzgrMDA6MDBUENJAAAAAJXRFWHRkYXRlOm1vZGlmeQAyMDIzLTEyLTExVDE2OjQ3OjE3KzAwOjAwGkZ8KwAAAABJRU5ErkJggg== + +[image_ref_image_osd_last_png]: +data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADcAAAA0CAAAAAALJP80AAAABGdBTUEAALGPC/xhBQAAACBjSFJNAAB6JgAAgIQAAPoAAACA6AAAdTAAAOpgAAA6mAAAF3CculE8AAAAAmJLR0QA/4ePzL8AAAAHdElNRQfnDAsRBCsAUB6ZAAAAEGNhTnYAAABDAAAASAAAAAIAAAAH0p+9FQAAAPFJREFUSMftlsERhCAMRf/ueIQCUgAWYBvUawMWsAVIARQgBexBF0USYdyD44y5AT4e0YAA94gXACjS1cDkAwA0AEC2rebG3kVOt139CgcAwPtkfk26binTbDRyvncAjOW5bDRywX0AIPDLykbP5vdwD/dw13HNvmM5H5NQVObmkyQNY8tcbmRsTH5kLZV6OJ/W8NgYFXUd8xdg3mc6P2tj89saBZvw/VaHYGN9q1G0ifUye0Rb5pvGtB2WIhinY873w28Gv28dccHJrZr8inHZ/lOm/LBROUc2FLnNjoqcrr8y/Z3fvkqOYqmcs/e6u8QXzO5OXKNeeskAAAAldEVYdGRhdGU6Y3JlYXRlADIwMjMtMTItMTFUMTc6MDM6MTMrMDA6MDD78Or5AAAAJXRFWHRkYXRlOm1vZGlmeQAyMDIzLTEyLTExVDE2OjQ3OjU5KzAwOjAwzjMJjAAAAABJRU5ErkJggg== diff --git a/doc/images/gq-marker.png b/doc/images/gq-marker.png new file mode 100644 index 0000000000000000000000000000000000000000..a93c995121a29f1c69a54783b41c38032782a4ca GIT binary patch literal 518 zcmeAS@N?(olHy`uVBq!ia0vp^Qb4T0#0(@0k2XvLagsfPd>I(3)EF2VS{N990fib~ zFff!FFfhDIU|_JC!N4G1FlSew4N!t7z$e5NNCUxtAo~CR;^bW(Kn`O`kY6x^!?PP{ zAWo9Ey9=`*kIyF{hrPtp*OmP_508Kv;{%_=4?*(zMSdZS=NFaF0&-MKTq8a zVqgWc85q16rQz%#Mh&PMCI$v3VT5|1S`Yw-5{#A)`fdVb2Yb3WhHzX@PDn`LNn~I? zrYdrg(ZPzrW4VD|;v9x0#*))FG``R|t{UWEWs?19(wdcwJdvxX>BVl%Vww=QlgG*V rhe73xsvUJRDh)nsmZ~?g{gh@1+Nb@p>$UFzpz#czu6{1-oD!MK!3-p$v;y}6DVB6cUq=Rpjs4tz5?O(Kg=CK) zUj~LMH3o);76yi2K%s^g3=E|P3=FRl7#OT(FffQ0%-I!a1C+=N@Ck7R(mXsos;a6+ zMn(k%1=FTYI{^f{cb{0a=md}*9)7~e=mZ19?nToUg&R#XVpz0$TKFO(qiGD&PE0d8 zVZ?BPVcPCRMvKB3rWs9JwA(0r5rYxP46r7U89)PohW-Elf7Slf2zslwwn3 z)&M!|C7!;n?9X|)1uP8vnZIZQg#?ll{mOuJ0uTc|!XO01Y>m+sr9isV)5S5wHM24{*ETS)GB98-Di=Y~kei>9nO2FW!NknU&={hD T@w71;Py>UftDnm{r-UW|zEr#b literal 0 HcmV?d00001 diff --git a/doc/images/image-osd-first.png b/doc/images/image-osd-first.png new file mode 100644 index 0000000000000000000000000000000000000000..d6db49b4532232e3494399613c7da2e32e3b8485 GIT binary patch literal 508 zcmeAS@N?(olHy`uVBq!ia0vp^hCpn@0VEhMBBoAm#*O*7O;dL8iX&ba4#vIR19p*|Ucg zcpT!jRdP`(kYX@0 zFf!IPG}1LR3^6pfGBC0-w$L^(ure?R5xC@lq9HdwB{QuOMT41@iMf@bIYfh$Ta7kQ O1B0ilpUXO@geCw`ZncU4 literal 0 HcmV?d00001 diff --git a/doc/images/image-osd-icon.png b/doc/images/image-osd-icon.png new file mode 100644 index 0000000000000000000000000000000000000000..70d762ac4ca88379f305ce6ef8b7ad7e23673df5 GIT binary patch literal 412 zcmeAS@N?(olHy`uVBq!ia0vp^hCpo20VEh2*8RN;q*&4&eH|GXHuiJ>Nn{1`6_P!I zd>I(3)PO2l7#MzmRK8$fC^cYUc$L7wU^Rn*LA+qju0R{01XGf?y9>kr_Wm>bfjssS zPhVH|=RDj3@@A(OU49D`5=c(;D+AISf%p&*>jH7BG-KmYAl>2V;uzv_{Oz=ZybTHh zEbfPexfU?!957pPolWNe(*g#r2Bw-HuEn!nFz@{Cx2bx14&SXAj?v0u&qEv{?K?X+ zxCErldfFG3uxGCG++R;s5~q52v&@+;teVHL^wq1nKEIMh!f%DI>RseJkZGCt_hLcO zp_r?+@9&y-hUNV`xvpqJxAU`;>Ywl5WW4r9RV$p&ZW7Q0*U(7U&@jZ%%*xon%EUz5z`)AD;O3WmQ&2SI=BH$)RpQpLVr7~JPy>UftDnm{ Hr-UW|B3Fi_ literal 0 HcmV?d00001 diff --git a/doc/images/image-osd-last.png b/doc/images/image-osd-last.png new file mode 100644 index 0000000000000000000000000000000000000000..0d59f8bfc6f3408c6a3f11d67a16ea8085adb330 GIT binary patch literal 517 zcmeAS@N?(olHy`uVBq!ia0vp^=0I%10VEi>RsNd*DVB6cUq=Rpjs4tz5?O(Kg=CK) zUj~LMH3o);76yi2K%s^g3=E|P3=FRl7#OT(FffQ0%-I!a1C(G&@^*J&_}|`tWP)Hy-(XR|hI|H!?5HkTW`=$ANMS=83PZ!4!kK=Er9TaR) z;Bo!`uA+r0h(Rnt`bsvl*alV)MiB+pH;&@2LWy^pANTBJw3EBo!0^38oI&H#)dNqM z8B7=)wyk}3?4GON_SnB%>NQjooeil!-mu_XBo&5Q> z6zl8{f5X}nl51B7Zt47LRP7S|Z1%A&veT3#mM5S4emI|Pf4*$t!INue{pl*a`7e0c zpACVQ?q(u8&-QiAS-0Ql@7(+Qy!w(>&e{BZ*X|?YXWse6ERL%>3G}>biEBhjN@7W> zRdP`(kYX@0Ff!IPG}1LR3^6pfGBCC>G}bmSure_C{o&P56b-rgDVb@NC>qSHOw6rJ XEg>4t8FTgkH86O(`njxgN@xNAua3Cu literal 0 HcmV?d00001 diff --git a/doc/images/image-osd-rotate-auto.png b/doc/images/image-osd-rotate-auto.png new file mode 100644 index 0000000000000000000000000000000000000000..56b8d6b1c2d162dfeb55a5231dbc82fbd4feece2 GIT binary patch literal 522 zcmeAS@N?(olHy`uVBq!ia0vp^hCpn}0VEjCro~(XQY`6?zK#qG8~eHcB(ehe3dtTp zz6=aiY77hwEes65fIEamTas2MIgS>|o zcwFnX`wSY`J=hX>pQSePU0_ULU~6Ek%2=d!kSRDcRAheTo*NtIGFHVgGXZ+EBhvhZP^swx3yijGIZ_Q{dlnHG5zPsFt`! zl%yncpt3=UY cW@Tb(Wn>J|kW$?L45)#@)78&qol`;+0N=~2)Bpeg literal 0 HcmV?d00001 diff --git a/scripts/doxygen.sh b/scripts/doxygen.sh index ee74caa0..2431d7b0 100755 --- a/scripts/doxygen.sh +++ b/scripts/doxygen.sh @@ -43,9 +43,10 @@ else DOCDIR="$PWD"/../doxygen fi -if ! mkdir -p "$DOCDIR"/doxygen +if ! mkdir -p "$DOCDIR"/ then printf "Cannot create %s\n" "$DOCDIR" + exit 1 fi export DOCDIR diff --git a/src/image-overlay.cc b/src/image-overlay.cc index bded7607..83976d8b 100644 --- a/src/image-overlay.cc +++ b/src/image-overlay.cc @@ -449,6 +449,23 @@ static GdkPixbuf *image_osd_info_render(OverlayStateData *osd) return pixbuf; } +/** + * @brief Create non-standard icons for the OSD + * @param flag + * @returns + * + * IMAGE_OSD_COLOR + * \image html image-osd-color.png + * IMAGE_OSD_FIRST + * \image html image-osd-first.png + * IMAGE_OSD_ICON + * \image html image-osd-icon.png + * IMAGE_OSD_LAST + * \image html image-osd-last.png + * IMAGE_OSD_ROTATE_AUTO + * \image html image-osd-rotate-auto.png + * + */ static GdkPixbuf *image_osd_icon_pixbuf(ImageOSDFlag flag) { static GdkPixbuf **icons = nullptr; -- 2.20.1