mirror of
https://github.com/storytold/harfbuzz.git
synced 2026-11-19 14:01:10 +01:00
This commit adds complete documentation for the dependency analysis API at all levels: public API, internal structures, and implementation. Public API documentation (src/hb-depend.cc, src/hb-depend.h): - Replaced "XXX Todo" placeholder in SECTION comment with detailed module description explaining dependency graphs and use cases - Fixed misleading hb_depend_t description (was only mentioning UVS) - Added full documentation for hb_depend_print() with debugging notes - Added usage examples to all three public functions - Updated all version tags from "?.0.0" to "REPLACEME" - Added experimental API warnings throughout Internal documentation (src/hb-depend-data.hh, src/hb-depend.hh): - Documented 5 internal structures with purpose and ownership semantics - Added comments explaining data relationships and lifecycle Algorithm documentation (src/hb-depend.cc): - Added detailed algorithm comments to 5 extraction methods explaining how dependencies are collected from each OpenType table (cmap, GSUB, glyf, COLR, MATH) User guide (docs/depend-api.md): - Created comprehensive 250-line API guide with: * Introduction with mechanism overview * Basic usage example (iterating dependencies) * Advanced examples (computing reachable glyphs, ligature sets) * API details and compilation instructions * Implementation notes including ownership semantics * Use cases (subsetting, coverage analysis, binning, testing) - Prominent experimental API warnings Build configuration (meson_options.txt): - Updated option description to emphasize experimental status All documentation follows HarfBuzz conventions and includes gtk-doc formatting for API reference generation.