From b7bf429a520969e62bf764a0f7d91008c992c2e5 Mon Sep 17 00:00:00 2001 From: Benjamin Dauvergne Date: Tue, 23 Feb 2021 20:39:25 +0100 Subject: [PATCH] docs: update gtk-doc-tools integration (#50441) Using reference documentation on https://developer.gnome.org/gtk-doc-manual/stable/index.html.en --- configure.ac | 2 +- docs/reference/lasso/Makefile.am | 40 ++++++++++++++----- .../lasso/{lasso-docs.sgml => lasso-docs.xml} | 37 +++++++++++------ 3 files changed, 55 insertions(+), 24 deletions(-) rename docs/reference/lasso/{lasso-docs.sgml => lasso-docs.xml} (96%) diff --git a/configure.ac b/configure.ac index e43de01f..b527def4 100644 --- a/configure.ac +++ b/configure.ac @@ -696,7 +696,7 @@ dnl API Reference documentation support # gtkdocize greps for ^GTK_DOC_CHECK and parses it, so you need to have # it on it's own line. m4_ifdef([GTK_DOC_CHECK], [ -GTK_DOC_CHECK(1.9) +GTK_DOC_CHECK([1.14],[--flavour no-tmpl]) ],[ AM_CONDITIONAL([ENABLE_GTK_DOC],[false]) ]) diff --git a/docs/reference/lasso/Makefile.am b/docs/reference/lasso/Makefile.am index 4e067a7e..82c6e762 100644 --- a/docs/reference/lasso/Makefile.am +++ b/docs/reference/lasso/Makefile.am @@ -1,8 +1,28 @@ -## Process this file with automake to produce Makefile.in - - -# We require automake 1.6 at least. -AUTOMAKE_OPTIONS = 1.6 +# -*- mode: makefile -*- +# +# Makefile.am - template makefile for gtk-doc module +# Copyright (C) 2007-2017 Stefan Sauer +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU General Public License for more details. +# +# You should have received a copy of the GNU General Public License +# along with this program. If not, see . +# +# As a special exception, the above copyright owner gives unlimited +# permission to copy, distribute and modify this Makefile.am template. +# You need not follow the terms of the GNU General Public License when +# using or distributing such Makefile.am files, even though portions of +# the text of the Makefile.am appear in them. The GNU General Public +# License (GPL) does govern all other use of the material that constitutes +# the Makefile.am template. # This is a blank Makefile.am for using gtk-doc. # Copy this to your project's API docs directory and modify the variables to @@ -15,9 +35,9 @@ DOC_MODULE=lasso # Uncomment for versioned docs and specify the version of the module, e.g. '2'. #DOC_MODULE_VERSION=2 +# The top-level XML file. +DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml -# The top-level SGML file. You can change this if you want to. -DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml # The directory containing the source code. Relative to $(srcdir). # gtk-doc will search all .c & .h files beneath here for inline comments @@ -32,13 +52,13 @@ SCANGOBJ_OPTIONS= # e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED" SCAN_OPTIONS=--ignore-decorators=LASSO_EXPORT -# Extra options to supply to gtkdoc-mkdb. -# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml -MKDB_OPTIONS=--sgml-mode --output-format=xml +# Extra options to supply to gtkdoc-mkdb # Extra options to supply to gtkdoc-mktmpl # e.g. MKTMPL_OPTIONS=--only-section-tmpl MKTMPL_OPTIONS= +# e.g. MKDB_OPTIONS=--xml-mode --output-format=xml +MKDB_OPTIONS=--xml-mode --output-format=xml # Extra options to supply to gtkdoc-mkhtml MKHTML_OPTIONS=--path=$(shell pwd) diff --git a/docs/reference/lasso/lasso-docs.sgml b/docs/reference/lasso/lasso-docs.xml similarity index 96% rename from docs/reference/lasso/lasso-docs.sgml rename to docs/reference/lasso/lasso-docs.xml index fead6fd9..028e03a2 100644 --- a/docs/reference/lasso/lasso-docs.sgml +++ b/docs/reference/lasso/lasso-docs.xml @@ -2,15 +2,19 @@ - + + + %gtkdocentities; ]> - + - Lasso Reference Manual - for Lasso &version; + &package_name; Reference Manual + + for &package_string;. The latest version of this documentation can be found on-line at http://lasso.entrouvert.org/documentation/index.html. + + Permission is granted to copy, distribute and/or modify this document @@ -537,13 +541,20 @@ the GNU General Public License< - - Appendix - - API Index + + + API Index + + + + + Index of deprecated API + + + + + Index of new API in 2.3 + - - - - + -- 2.30.0