Commit Graph

85 Commits

Author SHA1 Message Date
Khaled Hosny 9ab9f974d4 [docs] More buffers documentation 2016-01-01 20:38:21 +04:00
Khaled Hosny 85c2443b73 [docs] Reduce gtkdoc-check errors
Now it is just reporting one error about “503 undocumented or incomplete
symbols”, that will be the easy part I guess.
2015-12-30 22:57:04 +04:00
Khaled Hosny fb192c263e [docs] A bit more buffers documentation 2015-12-30 17:59:01 +04:00
Khaled Hosny 8ab797c5b8 [docs] A bit more buffers documentation 2015-12-30 17:59:01 +04:00
Khaled Hosny f18d2226b6 [docs] Some documentation on buffers
Some of it (create, reference, destroy) are adapted from Cairo docs.
2015-12-30 17:59:01 +04:00
Khaled Hosny 1f5559293f [docs] Ignore the new HB_EXTERN decoration
Otherwise, almost all API functions are not extracted.
2015-12-29 02:31:39 +04:00
Khaled Hosny d25317f67f Move more docs from FreeDesktop page 2015-12-24 01:52:17 +04:00
Khaled Hosny 493a922208 Rename user manual files
Use chapter ids instead of numbers, so that we can reorder them,
introduce new ones etc. without the numbers becoming out of date.
2015-12-24 01:52:17 +04:00
Khaled Hosny 4dc2265918 Intro from freedesktop.org/wiki/Software/HarfBuzz/ 2015-12-24 01:52:17 +04:00
Behdad Esfahbod 5783e05f81 [docs] Move docs/reference/ contents into docs/ 2015-08-31 19:18:10 +01:00
Behdad Esfahbod cd5e3a13a6 [docs] Fix out-of-tree build 2015-08-31 19:16:41 +01:00
Behdad Esfahbod 3899795fa3 Merge pull request #131 from simoncozens/docs
Use gtk-doc to build user's manual as well as reference
2015-08-31 10:46:01 +01:00
Simon Cozens 01e16e88f5 Combine user / reference information into gtk-doc generated manual. 2015-08-31 10:40:17 +01:00
Simon Cozens 11a07c4729 Correct tag hierarchy, to allow for table-of-contents entries. 2015-08-31 10:39:10 +01:00
Simon Cozens 387d6af428 Missing tag (oops). 2015-08-31 10:31:09 +01:00
Behdad Esfahbod d205965286 [docs] Fix typo 2015-08-31 10:12:05 +01:00
Simon Cozens 5470e744dd Current state and skeleton outline 2015-08-29 08:21:18 +01:00
Simon Cozens f0807654da First two chapters. More to follow. 2015-08-25 19:57:15 +01:00
Behdad Esfahbod 5ec5875acb Install git.mk in docs/ 2015-02-26 13:59:13 -08:00
Behdad Esfahbod 2b051c6057 Rename HB_VERSION_CHECK and hb_version_check to "atleast"
HB_VERSION_CHECK's comparison was originally written wrongly
by mistake.  When API tests were written, they were also written
wrongly to pass given the wrong implementation... Sigh.

Given the purpose of this API, there's no point in fixing it
without renaming it.  As such, rename.

API changes:

  HB_VERSION_CHECK -> HB_VERSION_ATLEAST
  hb_version_check -> hb_version_atleast
2014-06-20 14:09:57 -04:00
Behdad Esfahbod cabfa538ed Adjust unused doc symbols 2014-06-20 14:02:30 -04:00
Behdad Esfahbod b934b0f9d1 Yet another try to make build without gtk-doc succeed 2014-03-19 11:52:40 -07:00
Behdad Esfahbod a7a5be090d Another try to make gtk-doc optional 2014-03-19 11:39:23 -07:00
Luis de Bethencourt d507f6b5b7 Have Gtk-Doc ignore UCDN files 2013-12-16 17:04:44 -05:00
Behdad Esfahbod ae9dc717d3 [gtk-doc] Pass source files to gtk-doc 2013-09-05 16:40:37 -04:00
Behdad Esfahbod 63dd4b0ac2 [gtk-doc] Remove hack for deleting tmpl/
This was introduced in 029f46bde7
and was in fact a bug in gtk-doc master:

  https://bugzilla.gnome.org/show_bug.cgi?id=707426
2013-09-03 20:01:40 -04:00
Behdad Esfahbod a2a28235e8 [gtk-doc] Generate version.xml from configure
Even though this is not what autoconf recommends, it reduces doc
rebuilds when version doesn't change but configure changes.
2013-08-30 19:38:47 -04:00
Behdad Esfahbod e4ce6745e1 [gtk-doc] Fix build without gobject 2013-08-29 15:56:56 -04:00
Behdad Esfahbod 71439a8c7a [gobject] Flesh out hb-gobject
Move it to new harfbuzz-gobject library.  Implement enums and
boxed types for object-types.  Still have to do boxed types for
value types.
2013-08-28 12:38:37 -04:00
Behdad Esfahbod 2e3a07abdf Separate face source code from font
Makes documentation / introspection easier.
2013-08-27 11:46:08 -04:00
Behdad Esfahbod 381f2fb5e6 Minor 2013-08-27 11:46:07 -04:00
Behdad Esfahbod ac1f09b53e [gtk-doc] Fix maintainer-clean rule 2013-08-27 11:46:07 -04:00
Behdad Esfahbod 029f46bde7 [gtk-doc] Remove tmpl in make maintainer-clean 2013-08-26 18:11:07 -04:00
Behdad Esfahbod 700a15fe4b Add HB_DISABLE_DEPRECATED
That moment that you have to accept that you made API mistakes...
2013-08-26 17:49:36 -04:00
Anthony Carrico f7c72b42ef [gtk-doc] Initial setup
Initial setup of gtk-doc. Straight forward setup following the gtk-doc
instructions. Ignore some troublesome types in src/hb-gobject.h. To
build use "./autogen.sh --enable-gtk-doc" then "make". Docs are in
harfbuzz/docs/reference/html/index.html.
2013-08-26 17:32:30 -04:00