kc3-lang/harfbuzz/docs/Makefile.am

Branch : - branch - main - tag -

• Show log

  Commit

• Author : Khaled Hosny
  Date : 2022-12-19 00:15:04
  Hash : 734e5f7c
  Message : [doc] Add HB_DEPRECATED_FOR to --ignore-decorators Does not make a difference, though.

• docs/Makefile.am

• # Process this file with automake to produce Makefile.in
  
  # We require automake 1.6 at least.
  AUTOMAKE_OPTIONS = 1.6
  
  # This is a blank Makefile.am for using gtk-doc.
  # Copy this to your project's API docs directory and modify the variables to
  # suit your project. See the GTK+ Makefiles in gtk+/docs/reference for examples
  # of using the various options.
  
  # The name of the module, e.g. 'glib'.
  DOC_MODULE=harfbuzz
  
  # Uncomment for versioned docs and specify the version of the module, e.g. '2'.
  #DOC_MODULE_VERSION=$(HB_VERSION_MAJOR)
  
  # The top-level SGML file. You can change this if you want to.
  DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml
  
  # Directories containing the source code.
  # gtk-doc will search all .c and .h files beneath these paths
  # for inline comments documenting functions and macros.
  # e.g. DOC_SOURCE_DIR=$(top_srcdir)/gtk $(top_srcdir)/gdk
  DOC_SOURCE_DIR=$(top_srcdir)/src $(top_builddir)/src
  
  # Extra options to pass to gtkdoc-scangobj. Not normally needed.
  SCANGOBJ_OPTIONS=
  
  # Extra options to supply to gtkdoc-scan.
  # e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"
  SCAN_OPTIONS=--rebuild-types --deprecated-guards="HB_DISABLE_DEPRECATED" \
  	--ignore-decorators='HB_EXTERN|HB_DEPRECATED|HB_DEPRECATED_FOR()'
  
  # Header files or dirs to ignore when scanning. Use base file/dir names
  # e.g. IGNORE_HFILES=gtkdebug.h gtkintl.h private_code
  IGNORE_HFILES=`cd $(top_srcdir)/src; find . -path './*/*.h' | sed 's@^.*/@@'`
  IGNORE_HFILES+=hb-gobject.h hb-gobject-enums.h hb-gobject-structs.h
  
  # Extra options to supply to gtkdoc-mkdb.
  # e.g. MKDB_OPTIONS=--xml-mode --output-format=xml
  MKDB_OPTIONS=--source-suffixes=h,cc --xml-mode --output-format=xml --ignore-files="$(IGNORE_HFILES)"
  
  # Extra options to supply to gtkdoc-mktmpl
  # e.g. MKTMPL_OPTIONS=--only-section-tmpl
  MKTMPL_OPTIONS=
  
  # Extra options to supply to gtkdoc-mkhtml
  MKHTML_OPTIONS=
  
  # Extra options to supply to gtkdoc-fixref. Not normally needed.
  # e.g. FIXXREF_OPTIONS=--extra-dir=../gdk-pixbuf/html --extra-dir=../gdk/html
  FIXXREF_OPTIONS=
  
  # Used for dependencies. The docs will be rebuilt if any of these change.
  # e.g. HFILE_GLOB=$(top_srcdir)/gtk/*.h
  # e.g. CFILE_GLOB=$(top_srcdir)/gtk/*.c
  HFILE_GLOB=$(top_srcdir)/src/hb.h $(top_srcdir)/src/hb-*.h
  CFILE_GLOB=$(top_srcdir)/src/hb-*.cc
  
  # Extra header to include when scanning, which are not under DOC_SOURCE_DIR
  # e.g. EXTRA_HFILES=$(top_srcdir}/contrib/extra.h
  
  # Images to copy into HTML directory.
  # e.g. HTML_IMAGES=$(top_srcdir)/gtk/stock-icons/stock_about_24.png
  HTML_IMAGES=  \
  	HarfBuzz.png \
  	HarfBuzz.svg
  
  # Extra SGML files that are included by $(DOC_MAIN_SGML_FILE).
  # e.g. content_files=running.sgml building.sgml changes-2.0.sgml
  content_files=	\
  	usermanual-what-is-harfbuzz.xml \
  	usermanual-install-harfbuzz.xml \
  	usermanual-getting-started.xml \
  	usermanual-glyph-information.xml \
  	usermanual-shaping-concepts.xml \
  	usermanual-object-model.xml \
  	usermanual-buffers-language-script-and-direction.xml \
  	usermanual-fonts-and-faces.xml \
  	usermanual-opentype-features.xml \
  	usermanual-clusters.xml \
  	usermanual-utilities.xml \
  	usermanual-integration.xml \
  	version.xml
  
  # SGML files where gtk-doc abbreviations (#GtkWidget) are expanded
  # These files must be listed here *and* in content_files
  # e.g. expand_content_files=running.sgml
  expand_content_files=
  
  # CFLAGS and LDFLAGS for compiling gtkdoc-scangobj with your library.
  # Only needed if you are using gtkdoc-scangobj to dynamically query widget
  # signals and properties.
  # e.g. GTKDOC_CFLAGS=-I$(top_srcdir) -I$(top_builddir) $(GTK_DEBUG_FLAGS)
  # e.g. GTKDOC_LIBS=$(top_builddir)/gtk/$(gtktargetlib)
  GTKDOC_CFLAGS=
  GTKDOC_LIBS=$(top_builddir)/src/libharfbuzz.la
  if HAVE_GOBJECT
  GTKDOC_LIBS+=$(top_builddir)/src/libharfbuzz-gobject.la
  endif
  
  # This includes the standard gtk-doc make rules, copied by gtkdocize.
  include $(top_srcdir)/gtk-doc.make
  
  # Other files to distribute
  # e.g. EXTRA_DIST += version.xml.in
  EXTRA_DIST += version.xml.in meson.build
  
  # Files not to distribute
  # for --rebuild-types in $(SCAN_OPTIONS), e.g. $(DOC_MODULE).types
  # for --rebuild-sections in $(SCAN_OPTIONS) e.g. $(DOC_MODULE)-sections.txt
  #DISTCLEANFILES +=
  
  # Comment this out if you don't want 'make check' to test you doc status
  # and run some sanity checks
  if ENABLE_GTK_DOC
  TESTS_ENVIRONMENT = cd $(srcdir) && \
    DOC_MODULE=$(DOC_MODULE) DOC_MAIN_SGML_FILE=$(DOC_MAIN_SGML_FILE) \
    SRCDIR=$(abs_srcdir) BUILDDIR=$(abs_builddir)
  #TESTS = $(GTKDOC_CHECK)
  endif
  
  -include $(top_srcdir)/git.mk