30 Commits

Author SHA1 Message Date
michael-grunder f5ed17048b Update doctum docs 2026-04-08 18:42:21 -07:00
michael-grunder df243455e6 Docs: Update generated API documentation 2026-03-25 11:03:42 -07:00
michael-grunder d4600a2846 docs: Update rendered docs 2025-11-26 18:22:57 -08:00
michael-grunder c17f475caa docs: Add missing docblocs + example highlighting 2025-11-13 17:36:55 -08:00
michael-grunder 0981c2b7d7 docs: Document failover strategies. 2025-11-12 10:23:35 -08:00
michael-grunder 8ef349a2d9 docs: Document final undocumented constants. 2025-11-12 10:23:35 -08:00
michael-grunder 26cf6d9494 docs: Fully document backof strategies. 2025-11-12 10:23:35 -08:00
michael-grunder 49919b0ec5 docs: Document class constants 2025-11-12 10:23:35 -08:00
michael-grunder 76286d88a9 docs: Add @see annotations to the Redis or Valkey command docs 2025-11-11 09:22:31 -08:00
michael-grunder a46700cfc8 docs: Fix @see \Redis annotations so they hyperlink correctly.
It turns out `doctum` will only hyperlink to the Redis methods when the
method casing is identical. For that reason, just match the casing in
`redis_cluster.stub.php` to how it's cased in `redis.stub.php`.

We aren't changing any of the non-commented stub text, just the casing of the
`@see` annotations.

WIP: More

.
2025-11-11 09:22:31 -08:00
michael-grunder d5b1576e27 docs: Syntax highlight parameter arg names 2025-11-10 21:17:57 -08:00
michael-grunder 5fe0862109 docs: Syntax highlight string literals in green 2025-11-09 18:17:42 -08:00
michael-grunder 38e56d5738 docs: Highlight the individual doctum params 2025-11-09 18:17:42 -08:00
michael-grunder 9edc242579 docs: Apply syntax highlighting to the index section. 2025-11-09 18:17:42 -08:00
michael-grunder d45c4d294c docs: We want our docs based on develop not main 2025-11-09 18:17:42 -08:00
Michael Grunder ae69e47a08 Additional doctum syntax highlighting. (#2763)
* docs: Syntax highlight ```php ... ``` code blocks

* docs: More syntax highlighting

* docs: Allow `highlight.js` to syntax highlight `Redis`.

* docs: Rebuild doctum static files
2025-11-09 16:24:16 -08:00
michael-grunder 4cf670fed3 docs: Add syntax highlighting to method signatures 2025-11-08 21:26:37 -08:00
michael-grunder e460a8595a docs: Add doctum theme and syntax highlighting 2025-11-08 21:26:37 -08:00
michael-grunder 1297c48c14 docs: Initial syntax highlighing integration 2025-11-08 21:26:37 -08:00
michael-grunder 9e9ccbd441 Update doctum docs 2025-11-08 14:13:56 -08:00
michael-grunder ecdc290bba Update doctum docs 2025-11-07 11:49:57 -08:00
Viktor Szépe 37c5f8d451 Fix typos 2024-02-21 13:16:12 -08:00
Viktor Szépe 71ce6dd34c Fix documentation branch
main is no more
2023-03-01 10:02:16 -08:00
michael-grunder 872b69313b Documentation: Normalize formatting. 2022-11-18 00:02:16 -08:00
michael-grunder 72f8eb2565 Documentation: Rebuild docs. 2022-11-16 12:13:50 -08:00
michael-grunder 53d142d93a Documentation: Add more docblocks and fix up formatting. 2022-11-15 15:09:24 -08:00
michael-grunder ef4699c726 Documentation: Rework more formatting and add example sections.
[skip ci]
2022-11-10 19:36:06 -08:00
michael-grunder ecf6514400 Documentation: Render docs 2022-11-09 19:26:10 -08:00
michael-grunder 531177d42d Documentation: Render docs 2022-11-09 15:34:31 -08:00
Till Krüss 142bddf0b7 Add initial docs (#2249)
Initial support for `doctum` generated documentation.
2022-11-08 14:59:24 -08:00