From 9058040f2b7bc7d49b27d5060f3d63cdf3b669ec Mon Sep 17 00:00:00 2001 From: Nicola Fontana Date: Sun, 23 Jun 2013 16:08:28 +0200 Subject: [PATCH] doc: refactored to be more mainstream Dropped custom XSL and merged latest gtk-doc.make into Makefile.am.gtk-doc: there is no more need to have XML 1.0 compiant pages because the new online website is based on silverstripe-gtkdoc (http://dev.entidi.com/p/silverstripe-gtkdoc/) that accepts HTML code. Corrected minor bugs during the process: * removed wikilinks in @short_description because they are not properly handled by gtk-doc; * removed trailing dots from @short_description for consistency; * added index of new APIs introduced by 1.0 version; * added index of deprecated APIs (actually empty); * merged docs/gnu into docs/adg; * removed docs/common. --- Makefile.am | 27 +- build/Makefile.am.gtk-doc | 103 ++-- configure.ac | 21 +- docs/Makefile.am | 10 +- docs/{gnu => adg}/CONTRIBUTING.xml | 0 docs/{gnu => adg}/HACKING.xml | 0 docs/adg/Makefile.am | 16 +- docs/{gnu => adg}/NEWS.xml | 0 docs/{gnu => adg}/README.xml | 0 docs/{gnu => adg}/TODO.xml | 0 docs/adg/adg-docs.xml | 12 +- docs/common/devhelp2.xsl | 159 ------ docs/common/gtk-doc.xsl | 899 ------------------------------- docs/common/home.png | Bin 654 -> 0 bytes docs/common/left.png | Bin 459 -> 0 bytes docs/common/right.png | Bin 472 -> 0 bytes docs/common/style.css | 268 --------- docs/common/up.png | Bin 406 -> 0 bytes docs/common/version-greater-or-equal.xsl | 54 -- docs/cpml/Makefile.am | 7 +- docs/cpml/cpml-docs.xml | 10 + docs/{common => }/docbook2txt.xsl | 0 po-properties/it.po | 6 +- src/adg/adg-cairo-fallback.c | 2 +- src/adg/adg-dash.c | 2 +- src/adg/adg-gtk-area-gtk2.c | 4 +- src/adg/adg-gtk-area.c | 4 +- src/adg/adg-gtk-layout-gtk2.c | 2 +- src/adg/adg-gtk-layout.c | 2 +- src/adg/adg-matrix.c | 2 +- src/adg/adg-param-dress.c | 2 +- src/adg/adg-ruled-fill.c | 2 +- src/adg/adg-table-cell.c | 2 +- src/adg/adg-trail.c | 2 +- src/cpml/cpml-gobject.c | 2 +- 35 files changed, 140 insertions(+), 1480 deletions(-) rename docs/{gnu => adg}/CONTRIBUTING.xml (100%) rename docs/{gnu => adg}/HACKING.xml (100%) rename docs/{gnu => adg}/NEWS.xml (100%) rename docs/{gnu => adg}/README.xml (100%) rename docs/{gnu => adg}/TODO.xml (100%) delete mode 100644 docs/common/devhelp2.xsl delete mode 100644 docs/common/gtk-doc.xsl delete mode 100644 docs/common/home.png delete mode 100644 docs/common/left.png delete mode 100644 docs/common/right.png delete mode 100644 docs/common/style.css delete mode 100644 docs/common/up.png delete mode 100644 docs/common/version-greater-or-equal.xsl rename docs/{common => }/docbook2txt.xsl (100%) diff --git a/Makefile.am b/Makefile.am index 3d26165c..1b780d10 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,6 +1,6 @@ include $(top_srcdir)/build/Makefile.am.common -xml2txt_stylesheet= $(abs_srcdir)/docs/common/docbook2txt.xsl +xml2txt_stylesheet= $(abs_srcdir)/docs/docbook2txt.xsl xml2txt_command= $(AM_V_GEN)if test -x $(XSLTPROC) ; then : ; else \ echo ' *WARN libxslt-1.0.19 or later is required to generate $@' ; \ touch $@ ; \ @@ -33,11 +33,6 @@ EXTRA_DIST= COPYING \ build/adg-welcome.bmp \ build/adg.ico \ build/gschemas.compiled \ - docs/gnu/CONTRIBUTING.xml \ - docs/gnu/HACKING.xml \ - docs/gnu/NEWS.xml \ - docs/gnu/README.xml \ - docs/gnu/TODO.xml \ $(BUILT_SOURCES) CLEANFILES= test-report.xml \ test-report.html \ @@ -78,17 +73,17 @@ ChangeLog: fi # Autogenerated text docs -README: $(xml2txt_stylesheet) $(abs_srcdir)/docs/gnu/README.xml - $(xml2txt_command) $(abs_srcdir)/docs/gnu/README.xml +README: $(xml2txt_stylesheet) $(abs_srcdir)/docs/adg/README.xml + $(xml2txt_command) $(abs_srcdir)/docs/adg/README.xml -NEWS: $(xml2txt_stylesheet) $(abs_srcdir)/docs/gnu/NEWS.xml - $(xml2txt_command) $(abs_srcdir)/docs/gnu/NEWS.xml +NEWS: $(xml2txt_stylesheet) $(abs_srcdir)/docs/adg/NEWS.xml + $(xml2txt_command) $(abs_srcdir)/docs/adg/NEWS.xml -TODO: $(xml2txt_stylesheet) $(abs_srcdir)/docs/gnu/TODO.xml - $(xml2txt_command) $(abs_srcdir)/docs/gnu/TODO.xml +TODO: $(xml2txt_stylesheet) $(abs_srcdir)/docs/adg/TODO.xml + $(xml2txt_command) $(abs_srcdir)/docs/adg/TODO.xml -CONTRIBUTING: $(xml2txt_stylesheet) $(abs_srcdir)/docs/gnu/CONTRIBUTING.xml - $(xml2txt_command) $(abs_srcdir)/docs/gnu/CONTRIBUTING.xml +CONTRIBUTING: $(xml2txt_stylesheet) $(abs_srcdir)/docs/adg/CONTRIBUTING.xml + $(xml2txt_command) $(abs_srcdir)/docs/adg/CONTRIBUTING.xml -HACKING: $(xml2txt_stylesheet) $(abs_srcdir)/docs/gnu/HACKING.xml - $(xml2txt_command) $(abs_srcdir)/docs/gnu/HACKING.xml +HACKING: $(xml2txt_stylesheet) $(abs_srcdir)/docs/adg/HACKING.xml + $(xml2txt_command) $(abs_srcdir)/docs/adg/HACKING.xml diff --git a/build/Makefile.am.gtk-doc b/build/Makefile.am.gtk-doc index 2adcaf19..104c3993 100644 --- a/build/Makefile.am.gtk-doc +++ b/build/Makefile.am.gtk-doc @@ -1,19 +1,5 @@ # -*- mode: makefile -*- - -adg_docdir= $(abs_top_srcdir)/docs/common -GTKDOC_MKHTML= $(XSLTPROC) \ - --nonet --xinclude \ - --path $(abs_top_srcdir)/docs/gnu \ - --stringparam gtkdoc.bookname $(DOC_MODULE) \ - --stringparam gtkdoc.version "1.18" \ - --stringparam chunk.quietly 1 \ - --stringparam chunker.output.quiet 1 \ - $(MKHTML_OPTIONS) \ - $(adg_docdir)/gtk-doc.xsl \ - ../$(DOC_MAIN_SGML_FILE) - - #################################### # Everything below here is generic # #################################### @@ -43,7 +29,7 @@ SETUP_FILES = \ $(DOC_MODULE)-sections.txt \ $(DOC_MODULE)-overrides.txt -EXTRA_DIST = \ +EXTRA_DIST = \ $(HTML_IMAGES) \ $(SETUP_FILES) @@ -88,31 +74,40 @@ $(REPORT_FILES): sgml-build.stamp #### setup #### +GTK_DOC_V_SETUP=$(GTK_DOC_V_SETUP_$(V)) +GTK_DOC_V_SETUP_=$(GTK_DOC_V_SETUP_$(AM_DEFAULT_VERBOSITY)) +GTK_DOC_V_SETUP_0=@echo " DOC Preparing build"; + setup-build.stamp: - -@if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \ - echo ' DOC Preparing build'; \ + -$(GTK_DOC_V_SETUP)if test "$(abs_srcdir)" != "$(abs_builddir)" ; then \ files=`echo $(SETUP_FILES) $(expand_content_files) $(DOC_MODULE).types`; \ if test "x$$files" != "x" ; then \ for file in $$files ; do \ test -f $(abs_srcdir)/$$file && \ - cp -pu $(abs_srcdir)/$$file $(abs_builddir)/ || true; \ + cp -pu $(abs_srcdir)/$$file $(abs_builddir)/$$file || true; \ done; \ fi; \ fi - @touch setup-build.stamp + $(AM_V_at)touch setup-build.stamp #### scan #### -scan-build.stamp: $(HFILE_GLOB) $(CFILE_GLOB) scan-hook - @echo ' DOC Scanning header files' - @_source_dir='' ; \ +GTK_DOC_V_SCAN=$(GTK_DOC_V_SCAN_$(V)) +GTK_DOC_V_SCAN_=$(GTK_DOC_V_SCAN_$(AM_DEFAULT_VERBOSITY)) +GTK_DOC_V_SCAN_0=@echo " DOC Scanning header files"; + +GTK_DOC_V_INTROSPECT=$(GTK_DOC_V_INTROSPECT_$(V)) +GTK_DOC_V_INTROSPECT_=$(GTK_DOC_V_INTROSPECT_$(AM_DEFAULT_VERBOSITY)) +GTK_DOC_V_INTROSPECT_0=@echo " DOC Introspecting gobjects"; + +scan-build.stamp: $(HFILE_GLOB) $(CFILE_GLOB) + $(GTK_DOC_V_SCAN)_source_dir='' ; \ for i in $(DOC_SOURCE_DIR) ; do \ _source_dir="$${_source_dir} --source-dir=$$i" ; \ done ; \ gtkdoc-scan --module=$(DOC_MODULE) --ignore-headers="$(IGNORE_HFILES)" $${_source_dir} $(SCAN_OPTIONS) $(EXTRA_HFILES) - @if grep -l '^..*$$' $(DOC_MODULE).types > /dev/null 2>&1 ; then \ - echo " DOC Introspecting gobjects"; \ + $(GTK_DOC_V_INTROSPECT)if grep -l '^..*$$' $(DOC_MODULE).types > /dev/null 2>&1 ; then \ scanobj_options=""; \ gtkdoc-scangobj 2>&1 --help | grep >/dev/null "\-\-verbose"; \ if test "$(?)" = "0"; then \ @@ -127,34 +122,52 @@ scan-build.stamp: $(HFILE_GLOB) $(CFILE_GLOB) scan-hook test -f $$i || touch $$i ; \ done \ fi - @touch scan-build.stamp + $(AM_V_at)touch scan-build.stamp $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt: scan-build.stamp @true #### xml #### +GTK_DOC_V_XML=$(GTK_DOC_V_XML_$(V)) +GTK_DOC_V_XML_=$(GTK_DOC_V_XML_$(AM_DEFAULT_VERBOSITY)) +GTK_DOC_V_XML_0=@echo " DOC Building XML"; + sgml-build.stamp: setup-build.stamp $(DOC_MODULE)-decl.txt $(SCANOBJ_FILES) $(DOC_MODULE)-sections.txt $(DOC_MODULE)-overrides.txt $(expand_content_files) - @echo ' DOC Building XML' - @_source_dir='' ; \ + $(GTK_DOC_V_XML)_source_dir='' ; \ for i in $(DOC_SOURCE_DIR) ; do \ _source_dir="$${_source_dir} --source-dir=$$i" ; \ done ; \ gtkdoc-mkdb --module=$(DOC_MODULE) --output-format=xml --expand-content-files="$(expand_content_files)" --main-sgml-file=$(DOC_MAIN_SGML_FILE) $${_source_dir} $(MKDB_OPTIONS) - @touch sgml-build.stamp + $(AM_V_at)touch sgml-build.stamp sgml.stamp: sgml-build.stamp @true #### html #### +GTK_DOC_V_HTML=$(GTK_DOC_V_HTML_$(V)) +GTK_DOC_V_HTML_=$(GTK_DOC_V_HTML_$(AM_DEFAULT_VERBOSITY)) +GTK_DOC_V_HTML_0=@echo " DOC Building HTML"; + +GTK_DOC_V_XREF=$(GTK_DOC_V_XREF_$(V)) +GTK_DOC_V_XREF_=$(GTK_DOC_V_XREF_$(AM_DEFAULT_VERBOSITY)) +GTK_DOC_V_XREF_0=@echo " DOC Fixing cross-references"; + html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) - @echo ' DOC Building HTML' - @rm -rf html - @mkdir html - @cd html && $(GTKDOC_MKHTML) && \ - cp -f $(adg_docdir)/*.png ./ && cp -f $(adg_docdir)/*.css ./ && \ - echo "timestamp" > ../html.stamp || exit $? + $(GTK_DOC_V_HTML)rm -rf html && mkdir html && \ + mkhtml_options=""; \ + gtkdoc-mkhtml 2>&1 --help | grep >/dev/null "\-\-verbose"; \ + if test "$(?)" = "0"; then \ + if test "x$(V)" = "x1"; then \ + mkhtml_options="$$mkhtml_options --verbose"; \ + fi; \ + fi; \ + gtkdoc-mkhtml 2>&1 --help | grep >/dev/null "\-\-path"; \ + if test "$(?)" = "0"; then \ + mkhtml_options="$$mkhtml_options --path=\"$(abs_srcdir)\""; \ + fi; \ + cd html && gtkdoc-mkhtml $$mkhtml_options $(MKHTML_OPTIONS) $(DOC_MODULE) ../$(DOC_MAIN_SGML_FILE) -@test "x$(HTML_IMAGES)" = "x" || \ for file in $(HTML_IMAGES) ; do \ if test -f $(abs_srcdir)/$$file ; then \ @@ -164,16 +177,18 @@ html-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) cp $(abs_builddir)/$$file $(abs_builddir)/html; \ fi; \ done; - @echo ' DOC Fixing cross-references' - @gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS) - @touch html-build.stamp + $(GTK_DOC_V_XREF)gtkdoc-fixxref --module=$(DOC_MODULE) --module-dir=html --html-dir=$(HTML_DIR) $(FIXXREF_OPTIONS) + $(AM_V_at)touch html-build.stamp #### pdf #### +GTK_DOC_V_PDF=$(GTK_DOC_V_PDF_$(V)) +GTK_DOC_V_PDF_=$(GTK_DOC_V_PDF_$(AM_DEFAULT_VERBOSITY)) +GTK_DOC_V_PDF_0=@echo " DOC Building PDF"; + pdf-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) - @echo ' DOC Building PDF' - @rm -f $(DOC_MODULE).pdf - @mkpdf_options=""; \ + $(GTK_DOC_V_PDF)rm -f $(DOC_MODULE).pdf && \ + mkpdf_options=""; \ gtkdoc-mkpdf 2>&1 --help | grep >/dev/null "\-\-verbose"; \ if test "$(?)" = "0"; then \ if test "x$(V)" = "x1"; then \ @@ -190,7 +205,7 @@ pdf-build.stamp: sgml.stamp $(DOC_MAIN_SGML_FILE) $(content_files) done; \ fi; \ gtkdoc-mkpdf --path="$(abs_srcdir)" $$mkpdf_options $(DOC_MODULE) $(DOC_MAIN_SGML_FILE) $(MKPDF_OPTIONS) - @touch pdf-build.stamp + $(AM_V_at)touch pdf-build.stamp ############## @@ -205,7 +220,7 @@ distclean-local: rm -f $(SETUP_FILES) $(expand_content_files) $(DOC_MODULE).types; \ fi -maintainer-clean-local: clean +maintainer-clean-local: @rm -rf xml html install-data-local: @@ -242,7 +257,7 @@ uninstall-local: # Require gtk-doc when making dist # if ENABLE_GTK_DOC -dist-check-gtkdoc: +dist-check-gtkdoc: docs else dist-check-gtkdoc: @echo "*** gtk-doc must be installed and enabled in order to make dist" @@ -258,4 +273,4 @@ dist-hook: dist-check-gtkdoc dist-hook-local @cd $(distdir) && rm -f $(DISTCLEANFILES) @$(GTKDOC_REBASE) --online --relative --html-dir=$(distdir)/html -.PHONY : dist-hook-local docs scan-hook +.PHONY : dist-hook-local docs diff --git a/configure.ac b/configure.ac index ebc045ef..8f0b9648 100644 --- a/configure.ac +++ b/configure.ac @@ -37,6 +37,8 @@ m4_ifdef([AM_COND_IF],[], [AC_DEFUN([AM_COND_IF], [AS_IF([test -z "$$1_TRUE"],[$2],[$3])])]) +AC_DEFUN([ADG_DEPENDENCY], + [EXTRADIR="$EXTRADIR --extra-dir=$($PKG_CONFIG --variable=prefix $1)/share/gtk-doc/html/$2"]) # Check for host information @@ -129,8 +131,11 @@ AC_CONFIG_COMMANDS([default], # Check for required packages PKG_CHECK_MODULES([GLIB],[glib-2.0]) +ADG_DEPENDENCY([glib-2.0],[glib]) PKG_CHECK_MODULES([GOBJECT],[gobject-2.0 >= ]gobject_prereq) +ADG_DEPENDENCY([gobject-2.0],[gobject]) PKG_CHECK_MODULES([CAIRO],[cairo >= ]cairo_prereq) +ADG_DEPENDENCY([cairo],[cairo]) # Check for optional packages @@ -144,7 +149,8 @@ AS_IF([test "x${enable_pango}" != "xno"], [PKG_CHECK_MODULES([PANGO],[pangocairo >= ]pangocairo_prereq, [enable_pango=yes AC_DEFINE_UNQUOTED([PANGO_ENABLED],[1], - [Defined if the pango support is enabled.])], + [Defined if the pango support is enabled.]) + ADG_DEPENDENCY([pangocairo],[pango])], [AS_IF([test "x${enable_pango}" = "xyes"], [AC_MSG_ERROR([${PANGO_PKG_ERRORS} and pango support requested])], [enable_pango=no])])]) @@ -164,12 +170,17 @@ AS_CASE(["${with_gtk}"], # GTK+ autodetection, giving precedence to GTK+3 AS_IF([test "x${gtk3_pkg}" = "xyes"], - [PKG_CHECK_MODULES([GTK3],[gtk+-3.0 >= ]gtk3_prereq,[gtk_pkg=gtk3],[:])]) + [PKG_CHECK_MODULES([GTK3],[gtk+-3.0 >= ]gtk3_prereq, + [gtk_pkg=gtk3 + ADG_DEPENDENCY([gtk+-3.0],[gtk3])], + [:])]) AS_IF([test "x${gtk2_pkg}" = "xyes" -a "x${gtk_pkg}" = "x"], - [PKG_CHECK_MODULES([GTK2],[gtk+-2.0 >= ]gtk2_prereq,[gtk_pkg=gtk2],[:])]) + [PKG_CHECK_MODULES([GTK2],[gtk+-2.0 >= ]gtk2_prereq, + [gtk_pkg=gtk2 + ADG_DEPENDENCY([gtk+-2.0],[gtk2])], + [:])]) AS_IF([test "x${gtk_pkg}" != "x"],[with_gtk=${gtk_pkg}]) - # Handle "check" graceful degradation AS_IF([test "x${with_gtk}" = "xcheck"],[with_gtk=no]) @@ -369,6 +380,8 @@ AM_COND_IF([HAVE_GTK3], AC_SUBST([ADG_CFLAGS]) AC_SUBST([ADG_LIBS]) +AC_SUBST([EXTRADIR]) + # Generation diff --git a/docs/Makefile.am b/docs/Makefile.am index 7c4f9515..e4461598 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -3,12 +3,4 @@ include $(top_srcdir)/build/Makefile.am.common SUBDIRS= cpml \ adg -EXTRA_DIST= common/devhelp2.xsl \ - common/docbook2txt.xsl \ - common/gtk-doc.xsl \ - common/home.png \ - common/left.png \ - common/right.png \ - common/style.css \ - common/up.png \ - common/version-greater-or-equal.xsl +EXTRA_DIST= docbook2txt.xsl diff --git a/docs/gnu/CONTRIBUTING.xml b/docs/adg/CONTRIBUTING.xml similarity index 100% rename from docs/gnu/CONTRIBUTING.xml rename to docs/adg/CONTRIBUTING.xml diff --git a/docs/gnu/HACKING.xml b/docs/adg/HACKING.xml similarity index 100% rename from docs/gnu/HACKING.xml rename to docs/adg/HACKING.xml diff --git a/docs/adg/Makefile.am b/docs/adg/Makefile.am index 18da3bbb..92614cb5 100644 --- a/docs/adg/Makefile.am +++ b/docs/adg/Makefile.am @@ -6,13 +6,13 @@ DOC_SOURCE_DIR= $(abs_top_srcdir)/src/adg SCANGOBJ_OPTIONS= SCAN_OPTIONS= --rebuild-types \ --rebuild-sections -MKDB_OPTIONS= --sgml-mode \ +MKDB_OPTIONS= --name-space=adg \ + --sgml-mode \ --output-format=xml \ --default-includes="$(DOC_MODULE)-1/$(DOC_MODULE).h" MKHTML_OPTIONS= -HTML_OPTIONS= --stringparam chunker.output.doctype-public '-//W3C//DTD XHTML 1.0 Strict//EN' \ - --stringparam chunker.output.doctype-system 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd' -FIXXREF_OPTIONS= --extra-dir=$(top_srcdir)/docs/cpml +FIXXREF_OPTIONS= --extra-dir=$(top_srcdir)/docs/cpml/html \ + $(EXTRA_DIR) HFILE_GLOB= $(top_srcdir)/src/adg/*.h CFILE_GLOB= $(top_srcdir)/src/adg/*.c IGNORE_HFILES= adg.h \ @@ -59,7 +59,11 @@ IGNORE_HFILES= adg.h \ adg-type-builtins.h \ test-internal.h HTML_IMAGES= -content_files= +content_files= CONTRIBUTING.xml \ + HACKING.xml \ + NEWS.xml \ + README.xml \ + TODO.xml expand_content_files= GTKDOC_CFLAGS= -I$(top_srcdir)/src \ @@ -85,3 +89,5 @@ include $(top_srcdir)/build/Makefile.am.gtk-doc DISTCLEANFILES= $(DOC_MODULE)-sections.txt \ $(DOC_MODULE).types + +EXTRA_DIST+= $(content_files) diff --git a/docs/gnu/NEWS.xml b/docs/adg/NEWS.xml similarity index 100% rename from docs/gnu/NEWS.xml rename to docs/adg/NEWS.xml diff --git a/docs/gnu/README.xml b/docs/adg/README.xml similarity index 100% rename from docs/gnu/README.xml rename to docs/adg/README.xml diff --git a/docs/gnu/TODO.xml b/docs/adg/TODO.xml similarity index 100% rename from docs/gnu/TODO.xml rename to docs/adg/TODO.xml diff --git a/docs/adg/adg-docs.xml b/docs/adg/adg-docs.xml index 53b6a778..53efee9e 100644 --- a/docs/adg/adg-docs.xml +++ b/docs/adg/adg-docs.xml @@ -105,10 +105,20 @@ - Index + Index of all symbols + + Index of deprecated symbols + + + + + Index of new symbols in 1.0 + + + diff --git a/docs/common/devhelp2.xsl b/docs/common/devhelp2.xsl deleted file mode 100644 index 76a20b76..00000000 --- a/docs/common/devhelp2.xsl +++ /dev/null @@ -1,159 +0,0 @@ - - - - - - - - - - - - book - - - .devhelp2 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - , - - - - - diff --git a/docs/common/gtk-doc.xsl b/docs/common/gtk-doc.xsl deleted file mode 100644 index 38d0a1a8..00000000 --- a/docs/common/gtk-doc.xsl +++ /dev/null @@ -1,899 +0,0 @@ - - - - - - - - - - - - - - - 2 - - book toc - chapter toc - glossary toc - index toc - part toc - reference toc - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - en - - - - - - - - - - - - - - - - - - - No "en" localization of " - - " exists. - - - - - - - - bullet - - - - - - - - - - No "en" localization of dingbat - - exists; using "en". - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 1 - 0 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 1.36 - - - - -FATAL-ERROR: You need the DocBook XSL Stylesheets version 1.36 or higher -to build the documentation. -Get a newer version at http://docbook.sourceforge.net/projects/xsl/ - - - - - - - - - - - - - - - - - - - - - - - - - - - <ANCHOR id=" - - " href=" - - - / - - - "> - - - - - - <ONLINE href=" - - "> - - - - - - - - - - - - - - - - - - - - - - - - - - - -
- - - - - - - - - - - - -
-
- - - Generated by GTK-Doc V - - - Generated by GTK-Doc - - -
- - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - 1.66 - - - - - - - - - - - - 1.66 - - - - - - - - - - -
-
- -
-
- - - - - - - - - - - - -
- -
- - - - -
- - - -
- - - -

- - - -

- - -

- - - - - - - - -

- - -

- -

- 		- - - - - - - - - - -
-
- - - - - idx - - - - - - gls - - - - - - - - - - - - - [  -  |  - - - - -  ] - - - - - - - - - - - - - - - - - - - - - - - - - - - - - In gtk-doc.xsl: For acronym () no value found! - - - - http://foldoc.org/ - - - - - - - - - - - - - - - - - - diff --git a/docs/common/home.png b/docs/common/home.png deleted file mode 100644 index 17003611d9df2b066afc682cbde962f3a575002d..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcwPel00001 literal 654 zcwPaH0&)F`P)~yY zO1cF+0vxb!W?!x?K+*#62Jq)nA4q`)5S6sgX4ao{=)(Mgq+YMr)7sjak|a^9)zS!j zlk{-n29mabXYF=7SYBQx&vO8xC}MYams+hxqtO7sImhPaCf@rq;I^3!#u*2aUP)55 zT2&N90xmEJ0s&fGT~(T<3d2xYmK9C>IP*x-M@ib*+0pFm>>uW37N2Wzaq-fCnIZE9 zpb8}0+uN+KuQM2oZVHfP8U6kQdo3?>Wo2dT)WeM9So8DqhLi#T0 z-i(>mfjhvbsYV`;4sgfJ-p>G-SqJ!fjR6BQYs1h*y9xaN0l{VB;o%`08yiy@)$8@~ z2PD1gcDuiy;j1tR0v#V8OH%W)25-YKyx(j#IXO9*YWf0mb8}QG6@b@;cHxh9{t7+@ o!Yd`f8L$sLH?yBt^q3C6015TtIu@BS5dZ)H07*qoM6N<$f*igdr~m)} diff --git a/docs/common/left.png b/docs/common/left.png deleted file mode 100644 index 2d05b3d5b4aeec9384bbfe404bfc4ed0897051c4..0000000000000000000000000000000000000000 GIT binary patch literal 0 HcwPel00001 literal 459 zcwPa^0W|)JP)40xL?wO*>WZ(J#ML5j2<9jD6A%Q&kC}jOeEc;X{s;`zcnxLeZR6?6h#^ihmNF6NpGdilO$m<82oD9WQ|6nVv1`? z>KufRi{?QPXg;4;wroQu4?mN1Ydd@|kaQ|ZyWLK!)yi7Wb%=0{}lD)tfliHAUyWRQ+fD_;aV6j->y6!O_8bENg6P)Cd4HCN^TYHBC0dz3r5|}*T3c5!K}0^NPTey!^rYo;W&eW{b1SE%dR-1ljcju- zJITo5P_e{cPDWDszO|97o#m$fni3V4d%~7^?0HU4-k!+X`e~w55Q}HA=c?CM9`EK` z^o5GF_RsnG`ey+9wOf8O4bzg>7W*;jU~M?g`OZAA$mNp|Lz<$s+~N9!2`ir8RcClo$(Q~19INM~9}j;&*|enC yGd}kJak0wj?aUKd8;%}`i}SSew>!A-2iw}^5}Rh(M>+vRkipZ{&t;ucLK6U4uc96R diff --git a/docs/common/version-greater-or-equal.xsl b/docs/common/version-greater-or-equal.xsl deleted file mode 100644 index 8edcd81f..00000000 --- a/docs/common/version-greater-or-equal.xsl +++ /dev/null @@ -1,54 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - 1 - - - 0 - - - - - - - - - - - 0 - - - 1 - - - - - - diff --git a/docs/cpml/Makefile.am b/docs/cpml/Makefile.am index a96bf861..1c26f32d 100644 --- a/docs/cpml/Makefile.am +++ b/docs/cpml/Makefile.am @@ -6,13 +6,12 @@ DOC_SOURCE_DIR= $(abs_top_srcdir)/src/cpml SCANGOBJ_OPTIONS= SCAN_OPTIONS= --ignore-decorators="CPML_GNUC_CONST" \ --rebuild-sections -MKDB_OPTIONS= --sgml-mode \ +MKDB_OPTIONS= --name-space=cpml \ + --sgml-mode \ --output-format=xml \ --default-includes="$(DOC_MODULE)-1/$(DOC_MODULE).h" MKHTML_OPTIONS= -HTML_OPTIONS= --stringparam chunker.output.doctype-public '-//W3C//DTD XHTML 1.0 Strict//EN' \ - --stringparam chunker.output.doctype-system 'http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd' -FIXXREF_OPTIONS= +FIXXREF_OPTIONS= $(EXTRA_DIR) HFILE_GLOB= $(top_srcdir)/src/cpml/*.h CFILE_GLOB= $(top_srcdir)/src/cpml/*.c IGNORE_HFILES= cpml.h \ diff --git a/docs/cpml/cpml-docs.xml b/docs/cpml/cpml-docs.xml index 7ccaf30d..15940f4a 100644 --- a/docs/cpml/cpml-docs.xml +++ b/docs/cpml/cpml-docs.xml @@ -31,6 +31,16 @@ + + Index of deprecated symbols + + + + + Index of new symbols in 1.0 + + + diff --git a/docs/common/docbook2txt.xsl b/docs/docbook2txt.xsl similarity index 100% rename from docs/common/docbook2txt.xsl rename to docs/docbook2txt.xsl diff --git a/po-properties/it.po b/po-properties/it.po index b956aa7f..6b8b2ddc 100644 --- a/po-properties/it.po +++ b/po-properties/it.po @@ -9,7 +9,7 @@ msgid "" msgstr "" "Project-Id-Version: adg 1.0.x\n" "Report-Msgid-Bugs-To: \n" -"POT-Creation-Date: 2013-03-25 20:44+0100\n" +"POT-Creation-Date: 2013-06-23 14:49+0200\n" "PO-Revision-Date: 2013-02-15 15:37+0100\n" "Last-Translator: Nicola Fontana \n" "Language-Team: \n" @@ -607,11 +607,11 @@ msgstr "" "Specifica come le trasformazioni locali dell'entità corrente e dei suoi " "progenitori devono essere combinate per ottenere la matrice locale" -#: src/adg/adg-fill-style.c:106 +#: src/adg/adg-fill-style.c:107 msgid "Pattern" msgstr "Pattern" -#: src/adg/adg-fill-style.c:107 +#: src/adg/adg-fill-style.c:108 msgid "The cairo pattern set for this entity" msgstr "Il pattern cairo impostato per questa entità" diff --git a/src/adg/adg-cairo-fallback.c b/src/adg/adg-cairo-fallback.c index eb20a6f5..9f8a5fe7 100644 --- a/src/adg/adg-cairo-fallback.c +++ b/src/adg/adg-cairo-fallback.c @@ -21,7 +21,7 @@ /** * SECTION:adg-cairo-fallback * @title: Cairo wrappers - * @short_description: GObject wrappers for cairo structs. + * @short_description: GObject wrappers for cairo structs * * If GObject support has not been compiled in cairo, either by * explicitely disabling it or because the installed cairo version diff --git a/src/adg/adg-dash.c b/src/adg/adg-dash.c index 006668b1..afea8106 100644 --- a/src/adg/adg-dash.c +++ b/src/adg/adg-dash.c @@ -22,7 +22,7 @@ * SECTION:adg-dash * @Section_Id:AdgDash * @title: AdgDash - * @short_description: Dash pattern for line stroking. + * @short_description: Dash pattern for line stroking * * The #AdgDash boxed type wraps the values needed by cairo to * univoquely identify a dash pattern, an array of positive values. Each diff --git a/src/adg/adg-gtk-area-gtk2.c b/src/adg/adg-gtk-area-gtk2.c index 57eced55..5a10fdfc 100644 --- a/src/adg/adg-gtk-area-gtk2.c +++ b/src/adg/adg-gtk-area-gtk2.c @@ -20,8 +20,8 @@ /** * SECTION:adg-gtk-area - * @short_description: A #GtkWidget specifically designed to contain - * an #AdgCanvas entity + * @short_description: A widget specifically designed to contain + * an ADG canvas * * This is a #GtkDrawingArea derived object that provides an easy way * to show an ADG based canvas. The associated canvas can be set diff --git a/src/adg/adg-gtk-area.c b/src/adg/adg-gtk-area.c index 6921dc40..551cf9d6 100644 --- a/src/adg/adg-gtk-area.c +++ b/src/adg/adg-gtk-area.c @@ -20,8 +20,8 @@ /** * SECTION:adg-gtk-area - * @short_description: A #GtkWidget specifically designed to contain - * an #AdgCanvas entity + * @short_description: A widget specifically designed to contain an + * ADG canvas * * This is a #GtkDrawingArea derived object that provides an easy way * to show an ADG based canvas. The associated canvas can be set diff --git a/src/adg/adg-gtk-layout-gtk2.c b/src/adg/adg-gtk-layout-gtk2.c index 53f6076c..042b455c 100644 --- a/src/adg/adg-gtk-layout-gtk2.c +++ b/src/adg/adg-gtk-layout-gtk2.c @@ -20,7 +20,7 @@ /** * SECTION:adg-gtk-layout - * @short_description: A scrollable #AdgGtkArea based widget + * @short_description: A scrollable AdgGtkArea based widget * * This is an #AdgGtkArea derived object with scrolling capabilities. * It means an #AdgGtkLayout object can be added directly to a diff --git a/src/adg/adg-gtk-layout.c b/src/adg/adg-gtk-layout.c index 4af29b05..386977be 100644 --- a/src/adg/adg-gtk-layout.c +++ b/src/adg/adg-gtk-layout.c @@ -20,7 +20,7 @@ /** * SECTION:adg-gtk-layout - * @short_description: A scrollable #AdgGtkArea based widget + * @short_description: A scrollable AdgGtkArea based widget * * This is an #AdgGtkArea derived object with scrolling capabilities. * It means an #AdgGtkLayout object can be added directly to a diff --git a/src/adg/adg-matrix.c b/src/adg/adg-matrix.c index 059f086d..bde6deba 100644 --- a/src/adg/adg-matrix.c +++ b/src/adg/adg-matrix.c @@ -22,7 +22,7 @@ * SECTION:adg-matrix * @Section_Id:Matrix * @title: Matrix - * @short_description: #cairo_matrix_t enhancements and utilities. + * @short_description: cairo matrix enhancements and utilities * * The following functions augment the cairo_matrix_t available methods * providing some useful addition. diff --git a/src/adg/adg-param-dress.c b/src/adg/adg-param-dress.c index 72f3203d..6ee55e4b 100644 --- a/src/adg/adg-param-dress.c +++ b/src/adg/adg-param-dress.c @@ -22,7 +22,7 @@ * SECTION:adg-param-dress * @Section_Id:AdgParamDress * @title: AdgParamDress - * @short_description: Metadata for dress specification. + * @short_description: Metadata for dress specification * * The %ADG_TYPE_PARAM_DRESS type is a parameter specification * compatible with %G_TYPE_PARAM_ENUM that provides additional diff --git a/src/adg/adg-ruled-fill.c b/src/adg/adg-ruled-fill.c index a235228f..6cd94da3 100644 --- a/src/adg/adg-ruled-fill.c +++ b/src/adg/adg-ruled-fill.c @@ -20,7 +20,7 @@ /** * SECTION:adg-ruled-fill - * @short_description: A style composed of evenly spaced lines. + * @short_description: A style composed of evenly spaced lines * * The spacing between the lines could be changed using the * adg_ruled_fill_set_spacing() method. The angle of the lines should diff --git a/src/adg/adg-table-cell.c b/src/adg/adg-table-cell.c index 9d446ea7..df121001 100644 --- a/src/adg/adg-table-cell.c +++ b/src/adg/adg-table-cell.c @@ -22,7 +22,7 @@ * SECTION:adg-table-cell * @Section_Id:AdgTableCell * @title: AdgTableCell - * @short_description: A single cell of an #AdgTable + * @short_description: A single cell of a table * * The #AdgTableCell is a boxed type, the basic component of an * #AdgTable entity. It must be added to an #AdgTableRow that, diff --git a/src/adg/adg-trail.c b/src/adg/adg-trail.c index 1c4d235c..cca3f9fc 100644 --- a/src/adg/adg-trail.c +++ b/src/adg/adg-trail.c @@ -20,7 +20,7 @@ /** * SECTION:adg-trail - * @short_description: A bare model built around #cairo_path_t + * @short_description: A bare model built around cairo path * * The #AdgTrail model is a really basic model built around the #cairo_path_t * struct: for a full fledged path model consider using #AdgPath. diff --git a/src/cpml/cpml-gobject.c b/src/cpml/cpml-gobject.c index 233c2eb9..d764c6da 100644 --- a/src/cpml/cpml-gobject.c +++ b/src/cpml/cpml-gobject.c @@ -22,7 +22,7 @@ * SECTION:cpml-gobject * @Section_Id:GObject * @title: GObject wrappers - * @short_description: Collection of #GBoxed wrappers for CPML structs. + * @short_description: Collection of boxed wrappers for CPML structs * * These wrappers are supposed to make bindings development easier. * This file defines the wrappers and the functions needed for -- 2.11.4.GIT