diff options
author | Owen Taylor <otaylor@redhat.com> | 2001-02-12 17:46:17 +0000 |
---|---|---|
committer | Owen Taylor <otaylor@src.gnome.org> | 2001-02-12 17:46:17 +0000 |
commit | 008687b5b1419dce191056e683cfaf8d82116a9e (patch) | |
tree | f24b8c934bc7f0a4681e8d52719080bae51594d8 /docs | |
parent | a8685ec65f19b3dffe4029a9d17d018f62ec1798 (diff) | |
download | pango-008687b5b1419dce191056e683cfaf8d82116a9e.tar.gz |
srcdir != build dir fix.
Mon Feb 12 12:45:16 2001 Owen Taylor <otaylor@redhat.com>
* pango/Makefile.am: srcdir != build dir fix.
* docs/Makefile.am: Switching over to the new gtk-doc
Makefile.am.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/Makefile.am | 134 | ||||
-rw-r--r-- | docs/tmpl/main.sgml | 49 |
2 files changed, 133 insertions, 50 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am index c09e31fc..d68a5284 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -6,12 +6,22 @@ DOC_MODULE=pango # The top-level SGML file. DOC_MAIN_SGML_FILE=pango-docs.sgml -# The directory containing the source code -DOC_SOURCE_DIR=$(top_srcdir)/pango +# The directory containing the source code. Relative to $(srcdir) +DOC_SOURCE_DIR=../pango + +# Extra options to supply to gtkdoc-scan +SCAN_OPTIONS= + +# Extra options to supply to gtkdoc-mkdb +MKDB_OPTIONS= # Extra options to supply to gtkdoc-fixref FIXXREF_OPTIONS= +# Used for dependencies +HFILE_GLOB=$(top_srcdir)/pango/*.h +CFILE_GLOB=$(top_srcdir)/pango/*.c + # Headers to ignore IGNORE_HFILES= \ mini-fribidi \ @@ -23,29 +33,36 @@ IGNORE_HFILES= \ pangowin32-private.h \ pangox-private.h -tmpl_sources = \ - tmpl/coverage-maps.sgml \ - tmpl/engines.sgml \ - tmpl/fonts.sgml \ - tmpl/freetype-fonts.sgml \ - tmpl/glyphs.sgml \ - tmpl/layout.sgml \ - tmpl/main.sgml \ - tmpl/modules.sgml \ - tmpl/tab-stops.sgml \ - tmpl/text-attributes.sgml \ - tmpl/win32-fonts.sgml \ - tmpl/x-fonts.sgml \ - tmpl/x-rendering.sgml +# Extra files to add when scanning +EXTRA_HFILES= +# Images to copy into HTML directory +HTML_IMAGES = \ + layout.gif + +# Non-autogenerated SGML files to be included in $(DOC_MAIN_SGML_FILE) content_files = \ pango_markup.sgml extra_files = \ - layout.gif \ layout.fig \ layout.eps +# CFLAGS and LDFLAGS for compiling scan program. Only needed +# if $(DOC_MODULE).types is non-empty. +GTKDOC_CFLAGS = +GTKDOC_LIBS = + +# Commands for compiling and linking +GTKDOC_CC=$(LIBTOOL) --mode=compile $(CC) +GTKDOC_LD=$(LIBTOOL) --mode=link $(CC) + +dist-hook-local: + mkdir $(distdir)/TEXT; \ + for f in $(srcdir)/TEXT/* ; do \ + test -f $$f && cp -p $$f $(distdir)/TEXT; \ + done + #################################### # Everything below here is generic # @@ -56,46 +73,74 @@ TARGET_DIR=$(HTML_DIR)/$(DOC_MODULE) EXTRA_DIST = \ $(content_files) \ $(extra_files) \ + $(HTML_IMAGES) \ $(DOC_MAIN_SGML_FILE) \ - $(DOC_MODULE)-decl.txt \ + $(DOC_MODULE).types \ $(DOC_MODULE)-sections.txt \ $(DOC_MODULE)-overrides.txt +DOC_STAMPS=scan-build.stamp tmpl-build.stamp sgml-build.stamp html-build.stamp + if ENABLE_GTK_DOC -all-local: html/index.html +all-local: html-build.stamp + +SCANOBJ_FILES = \ + $(DOC_MODULE).args \ + $(DOC_MODULE).hierarchy \ + $(DOC_MODULE).signal + +scan-build.stamp: $(HFILE_GLOB) + @echo '*** Scanning header files ***' + cd $(srcdir) && ( \ + if grep -l '^.+$$' $(DOC_MODULE).types > /dev/null ; then \ + CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" gtkdoc-scangobj --module=$(DOC_MODULE) ; \ + else \ + for i in $(SCANOBJ_FILES) ; do \ + test -f $$i || touch $$i ; \ + done \ + fi ) + cd $(srcdir) && \ + gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" $(SCAN_OPTIONS) $(EXTRA_HFILES) + touch scan-build.stamp + +check_scan: + $(MAKE) scan-build.stamp -$(DOC_MODULE)-decl.txt: - $(MAKE) scan +$(DOC_MODULE)-decl.txt $(SCANOBJ_FILES): check_scan -$(tmpl_sources): $(DOC_MODULE)-decl.txt $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt - $(MAKE) templates +tmpl-build.stamp: $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt + @echo '*** Rebuilding template files ***' + cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) + touch tmpl-build.stamp -sgml/$(DOC_MODULE)-doc.bottom: $(tmpl_sources) $(DOC_MODULE)-decl.txt - $(MAKE) sgml +check_templates: + $(MAKE) tmpl-build.stamp -html/index.html: sgml/$(DOC_MODULE)-doc.bottom $(DOC_MAIN_SGML_FILE) - $(MAKE) html -endif +tmpl.stamp: check_templates -scan: - -(cd $(srcdir) \ - && gtkdoc-scan --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) --ignore-headers="$(IGNORE_HFILES)" ) +sgml-build.stamp: tmpl.stamp $(CFILE_GLOB) + @echo '*** Building SGML ***' + cd $(srcdir) && \ + gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) $(MKDB_OPTIONS) + touch sgml-build.stamp -templates: - cd $(srcdir) && gtkdoc-mktmpl --module=$(DOC_MODULE) +check_sgml: + $(MAKE) sgml-build.stamp -sgml: - cd $(srcdir) \ - && gtkdoc-mkdb --module=$(DOC_MODULE) --source-dir=$(DOC_SOURCE_DIR) +sgml.stamp: check_sgml -html: +html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) + @echo '*** Building HTML ***' test -d $(srcdir)/html || mkdir $(srcdir)/html - -cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE) + cd $(srcdir)/html && gtkdoc-mkhtml $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE) + test "x$(HTML_IMAGES)" = "x" || ( cd $(srcdir) && cp $(HTML_IMAGES) html ) @echo '-- Fixing Crossreferences' cd $(srcdir) && gtkdoc-fixxref --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS) + touch html-build.stamp +endif clean-local: - rm -f *~ *.bak *.signals *-unused.txt + rm -f *~ *.bak $(SCANOBJ_FILES) *-unused.txt $(DOC_STAMPS) $(srcdir)/sgml.stamp maintainer-clean-local: clean cd $(srcdir) && rm -rf sgml html $(DOC_MODULE)-decl-list.txt $(DOC_MODULE)-decl.txt @@ -125,7 +170,7 @@ dist-check-gtkdoc: @false endif -dist-hook: dist-check-gtkdoc +dist-hook: dist-check-gtkdoc dist-hook-local mkdir $(distdir)/tmpl mkdir $(distdir)/sgml mkdir $(distdir)/html @@ -134,9 +179,8 @@ dist-hook: dist-check-gtkdoc -cp $(srcdir)/sgml/*.bottom $(srcdir)/sgml/*.top $(distdir)/sgml -cp $(srcdir)/html/index.sgml $(distdir)/html -cp $(srcdir)/html/*.html $(srcdir)/html/*.css $(distdir)/html - mkdir $(distdir)/TEXT; \ - for f in $(srcdir)/TEXT/* ; do \ - test -f $$f && cp -p $$f $(distdir)/TEXT; \ - done + for i in $(HTML_IMAGES) ; do \ + cp $(srcdir)/$$i $(distdir)/html ; \ + done -.PHONY : html sgml templates scan +.PHONY : check_sgml check_templates check_scan dist-hook-local diff --git a/docs/tmpl/main.sgml b/docs/tmpl/main.sgml index 7f97791e..e9cb3a98 100644 --- a/docs/tmpl/main.sgml +++ b/docs/tmpl/main.sgml @@ -171,12 +171,12 @@ for text. @context: @text: +@start_index: @length: @attrs: +@cached_iter: @Returns: <!-- # Unused Parameters # --> -@start_index: -@cached_iter: @lang_info: @n_langs: @@ -206,6 +206,17 @@ for text. @Returns: +<!-- ##### FUNCTION pango_item_split ##### --> +<para> + +</para> + +@orig: +@split_index: +@split_offset: +@Returns: + + <!-- ##### FUNCTION pango_reorder_items ##### --> <para> @@ -342,16 +353,44 @@ for text. @log_attrs: +<!-- ##### FUNCTION pango_find_paragraph_boundary ##### --> +<para> + +</para> + +@text: +@length: +@paragraph_delimiter_index: +@next_paragraph_start: + + +<!-- ##### FUNCTION pango_default_break ##### --> +<para> + +</para> + +@text: +@length: +@analysis: +@attrs: + + <!-- ##### STRUCT PangoLogAttr ##### --> <para> The #PangoLogAttr structure stores information about the attributes of a single character. </para> -@is_break: +@is_line_break: +@is_mandatory_break: +@is_char_break: @is_white: -@is_char_stop: -@is_word_stop: +@is_cursor_position: +@is_word_start: +@is_word_end: +@is_sentence_boundary: +@is_sentence_start: +@is_sentence_end: <!-- ##### FUNCTION pango_shape ##### --> <para> |