22 Commits

Author SHA1 Message Date
bbbbbr
913dc5453d Docs: web css: make code highlights stand out more, reduce animation times 2025-12-10 15:56:19 -08:00
bbbbbr
29e436c835 Docs: Update changelog / migration through Dec 5, 2025
- Enable readable anchors in doxyfile
- Minor MegaDuck printer docs updates
- ZX0 compression updates
2025-12-06 02:19:42 -08:00
bbbbbr
efc4846444 docs: html: minor css tweaks for link opacity and UL/OL top margin 2025-11-26 20:25:24 -08:00
bbbbbr
541367b8d2 Docs: add readable link patch for doxygen 1.9.2
- Makes readable function name links instead of md5 hashes of the links
2025-11-25 23:53:14 -08:00
bbbbbr
50e4bacf48 Docs: allow explicit path to doxygen command
- Change min ver to 1.9.2
2025-11-25 03:03:16 -08:00
bbbbbr
5d94e1ab15 Docs: switch to doxygen-awesome theme 2025-11-25 01:51:59 -08:00
bbbbbr
f908880706 Docs: doxygen: define NINTENDO when parsing headers. fixes EMU_profiler_message() not showing up in docs
- Also move comment for function inside platform ifdef
2023-08-15 09:58:52 -07:00
bbbbbr
7bc8c2f29a Docs: Add warning about reading from VRAM
- Improve doxygen @note styling
- Convert several entries of "Note:" to @note
- Fix incorrect link anchor for mac os security warning in faq
- Add some missing SDCC versions to older release notes
2023-06-07 02:21:40 -07:00
bbbbbr
aa8a40f400 Docs: 4.2.0 Update doxygen theme css overrides to fix search box location 2023-02-27 22:09:36 -08:00
bbbbbr
589d04d05a Docs: Doxygen path config from makefile 2022-10-28 00:54:59 -07:00
bbbbbr
12e485f24b Docs: Add a nicer table for MBCs, not sure if it's entirely better
- Improve formatting of old one
- Improve doxygen markdown css
2022-06-14 01:01:42 -07:00
bbbbbr
f1f1d17a2d Doxygen: update header file constant gbz80 -> sm83
- Fixes initrand() doxygen warnings
2022-06-09 23:55:45 -07:00
bbbbbr
9893f998ba Updates for 4.0.6
- Add version number to front of PDF and HTML docs(controlled my version in root makefile)
- Little improvements to memcmp() and strncmp()
2022-02-01 00:17:49 -08:00
bbbbbr
4e3f5e71fb Docs: doxygen config: turn on #define of __TARGET_gb to find more fnctions 2021-09-23 19:53:47 -07:00
bbbbbr
ef7e100361 Docs: Doxygen config: Define __PORT_gbz80
- Fixes issue where function definitions would be ignored if no valid PORT was defined
- Defaults to GB Port for documentation when required
- See: PREDEFINED = __PORT_gbz80
2021-09-09 23:52:30 -07:00
bbbbbr
50b43764ec Makefile: Add docspdf target (make docspdf)
Docs: PDF: copy pdf from /docs/ to build output during normal build
Docs: Add initial version of PDF manual

Docs: PDF: Tune latex output - reduce size of index, add document generation date

Docs: Add comments about required tools to generate doxygen PDF output
2021-03-20 20:40:18 -07:00
bbbbbr
768737d957 Docs: PDF generation: initial work
To-do: 
  rename markdown pages to give them correct order in PDF chapters (01_..., 02..., etc) since subpage ordering does not seem to apply to latex output.

Setup: 
    sudo apt install texlive-latex-base
    sudo apt install texlive-latex-recommended
    sudo apt install texlive-latex-extra

Generate:
    cd /docs/latex
    make
    cp refman.pdf ../gbdk_manual.pdf
    cd ../..
    rm -rf docs/latex
2021-03-19 14:44:00 -07:00
bbbbbr
2a2edb7694 Docs: Update doxygen config file for markdown pages. Minor CSS improvement for code formatting 2021-01-22 22:19:31 -08:00
bbbbbr
d59a5e389e Docs: Turn on optimize for C output (changes 'classes' category to 'data structures', etc) 2020-11-04 08:41:35 -08:00
bbbbbr
6e13de049e Docs: Fix 'make docs' (doxyfile environment vars needed updating) 2020-11-03 21:04:08 -08:00
bbbbbr
eeb49f10f4 Docs: doxygen output: remove fixed width of 980 pixels, make it work better on smaller screens and browser windows 2020-10-30 16:17:35 -07:00
bbbbbr
be388de2e7 Docs: Add 'make docs' and 'make docsclean' to Makefile (generates into /docs/api/, doxygen config file and theme, minimal Github Pages theme config and index file (point Pages root to /docs/ folder). Currently using Doxygen 1.8.17. 2020-10-30 15:53:47 -07:00