Commit Graph

11340 Commits

Author SHA1 Message Date
Khaled Hosny ea0907abf9 [docs] Document version macros 2020-12-30 19:21:49 -08:00
Khaled Hosny 5e9f05ff3f [docs] Expand memory modes docs
Per Behdad suggestions.
2020-12-30 19:21:49 -08:00
Khaled Hosny 5151c2b668 [introspection] Replace deprecated allow-none
Use optional or nullable as appropriate.
2020-12-30 19:21:49 -08:00
Khaled Hosny a64d56a3e5 [introspection] nullable is for pointers 2020-12-30 19:21:49 -08:00
Khaled Hosny 9936490c04 [docs] Invalid use of "optional" annotation
It is valid only for out and inout parameters.

Fixes https://github.com/harfbuzz/harfbuzz/issues/1787
2020-12-30 19:21:49 -08:00
Khaled Hosny bf5b4b71c5 [docs] Duplicated documentation 2020-12-30 19:21:49 -08:00
Khaled Hosny 3d7a361648 [docs] Miscellaneous missing docs 2020-12-30 19:21:49 -08:00
Khaled Hosny a31a51cdec [docs] Complete hb-ft docs a bit 2020-12-30 19:21:49 -08:00
Khaled Hosny 8c492d5c32 [docs] Complete hb-ot-math docs a bit 2020-12-30 19:21:49 -08:00
Khaled Hosny 3f7ffd1b3d [docs] Complete hb-unicode docs a bit 2020-12-30 19:21:49 -08:00
Khaled Hosny 2fdab788ad [docs] Complete hb-buffer docs a bit 2020-12-30 19:21:49 -08:00
Khaled Hosny 492a5a9096 [docs] Complete hb-aat docs a bit 2020-12-30 19:21:49 -08:00
Khaled Hosny 3a012cc469 [docs] Complete hb-metrics docs a bit 2020-12-30 19:21:49 -08:00
Khaled Hosny 5a55b31a38 [docs] Complete hb-shape-plan docs a bit 2020-12-30 19:21:49 -08:00
Khaled Hosny 8e8c3e5878 [docs] Complete hb-ot-layout docs a bit 2020-12-30 19:21:49 -08:00
Khaled Hosny 5b7b730d4b [docs] Complete hb-color docs a bit 2020-12-30 19:21:49 -08:00
Khaled Hosny aa107e657b [docs] Complete hb-font docs a bit 2020-12-30 19:21:49 -08:00
Khaled Hosny 9b602e8e22 [docs] Complete hb-common docs a bit 2020-12-30 19:21:49 -08:00
Khaled Hosny 53ed5597b2 [docs] Add missing API indices 2020-12-30 23:28:26 +02:00
Khaled Hosny c9c3b3c94c [docs] Use correct syntax 2020-12-30 23:28:26 +02:00
Khaled Hosny a8e72ee784 [docs] Use %true and %false consistently 2020-12-30 23:28:26 +02:00
Khaled Hosny a3fe43a410 [docs] Hide private enum values
"/*< skip >*/" does not seem to hide them.
2020-12-30 23:06:18 +02:00
Khaled Hosny b8e6f17eed [docs] Move note about harfbuzz-old to proper place
Commit 443f872132 seems to have moved it
to the API part by mistake.
2020-12-30 11:55:24 -08:00
Khaled Hosny e93de6362b [docs] Document unused language in get_baseline
Document that language_tag in hb_ot_layout_get_baseline() is currently
unused.

Fixes https://github.com/harfbuzz/harfbuzz/issues/2662
2020-12-30 11:53:46 -08:00
Khaled Hosny c7b2e64c6d [docs] make it clear that FT_Face must have size
Fixes https://github.com/harfbuzz/harfbuzz/issues/2590
2020-12-30 11:50:49 -08:00
Khaled Hosny 4136ecf741 [docs] Don’t use FreeType in the simple example
Also make the code actually compile.

Fixes https://github.com/harfbuzz/harfbuzz/issues/2106
2020-12-30 11:50:14 -08:00
Khaled Hosny bfe4bbfc05 [docs] Older GTK-Doc does not support HB_DEPRECATED_FOR() at all
Fixes CI build failure.
2020-12-27 13:53:04 -08:00
Khaled Hosny 4161146e62 [docs] Fix generated docs for deprecated symbols
Without ignoring HB_DEPRECATED, most deprecated symbols get missing from
documentation. Ignoring HB_DEPRECATED_FOR does not work, but this seems
to be a GTK-Doc bug.
2020-12-27 13:53:04 -08:00
Khaled Hosny 7236c7e29c 2.7.4 2020-12-27 01:59:00 +02:00
Khaled Hosny 6808b1fb30
Merge pull request #2781 from harfbuzz/g-i-dist
[ci] Install gobject-introspection on distcheck job
2020-12-27 01:55:15 +02:00
Khaled Hosny e8c15b7a1c [ci] Install gobject-introspection on distcheck job
To fix missing --enable-introspection from release tarballs.

Fixes https://github.com/harfbuzz/harfbuzz/issues/2779
2020-12-26 23:17:08 +02:00
Khaled Hosny 010bd54040
Merge pull request #2777 from harfbuzz/docs-unicode
[docs] Improve hb-unicode docs a bit
2020-12-26 01:17:27 +02:00
Khaled Hosny 462b71eaf3
Merge pull request #1676 from n8willis/docs-gtkdoc-core
[Docs] Add gtkdoc comments for low-level core APIs
2020-12-26 01:16:32 +02:00
Khaled Hosny 22468c8a90 [docs] Give destroy callbacks have (optional) annotation 2020-12-24 22:38:06 +02:00
Khaled Hosny 35c4a15a67 [docs] Update hb-font documentation 2020-12-24 22:34:26 +02:00
Khaled Hosny 8586f15957 [docs] Update hb-common documentation 2020-12-24 22:23:47 +02:00
Khaled Hosny e8c21e003d [docs] Remove comments the duplicate docs 2020-12-24 21:56:31 +02:00
Khaled Hosny ff96f73f8f [docs] Add some missing API to harfbuzz-sections.txt 2020-12-24 21:53:11 +02:00
Khaled Hosny cb319f0d80 [docs] Add some missing annotations to hb-buffer.cc 2020-12-24 21:47:05 +02:00
Khaled Hosny 9af0edd951 [docs] Document return value of hb_blob_get_data() 2020-12-24 21:41:14 +02:00
Khaled Hosny f88e845fc7 [docs] Minor fixes 2020-12-24 21:34:14 +02:00
Nathan Willis 82092d4005 [docs] Update gtk-doc comments in hb-font 2020-12-24 21:34:14 +02:00
Nathan Willis e8de26e1ef [docs] Add gtkdoc comments to hb-buffer 2020-12-24 21:34:14 +02:00
Nathan Willis d13b7eaaf1 [docs] Add gtkdoc comments to hb-blob 2020-12-24 21:34:14 +02:00
Nathan Willis 4cdb12a3fa [docs] Add gtkdoc comments to hb-common 2020-12-24 21:34:14 +02:00
Nathan Willis 922c32eb2d [docs] Add gtkdoc comments to hb-map 2020-12-24 21:30:03 +02:00
Nathan Willis 71af2c6d9b [docs] Add gtkdoc comments to hb-set 2020-12-24 21:29:56 +02:00
Nathan Willis ec98730ff6 [docs] regularize whitespace in function params 2020-12-24 21:29:47 +02:00
Khaled Hosny fdf3e448fd [docs] Improve hb-unicode docs a bit
Down to only one warning.
2020-12-24 00:52:02 +02:00
Khaled Hosny 0fd6144a5f [docs] Fix warnings about unknown annotations
Use square brackets so that gtk-doc does not consider these to be
annotations.
2020-12-24 00:20:24 +02:00