Projet

Général

Profil

0001-docs-update-gtk-doc-tools-integration-50441.patch

Benjamin Dauvergne, 23 février 2021 21:13

Télécharger (6,14 ko)

Voir les différences: 

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%)
configure.ac
696 696 
# gtkdocize greps for ^GTK_DOC_CHECK and parses it, so you need to have
697 697 
# it on it's own line.
698 698 
m4_ifdef([GTK_DOC_CHECK], [
699 
GTK_DOC_CHECK(1.9)
699 
GTK_DOC_CHECK([1.14],[--flavour no-tmpl])
700 700 
],[
701 701 
AM_CONDITIONAL([ENABLE_GTK_DOC],[false])
702 702 
])
docs/reference/lasso/Makefile.am
1 
## Process this file with automake to produce Makefile.in
2 

  		




  3
  
  
    

  		




  4
  
  
    
# We require automake 1.6 at least.

  		




  5
  
  
    
AUTOMAKE_OPTIONS = 1.6

  		




  
  1
  
    
# -*- mode: makefile -*-

  		




  
  2
  
    
#

  		




  
  3
  
    
# Makefile.am - template makefile for gtk-doc module

  		




  
  4
  
    
# Copyright (C) 2007-2017  Stefan Sauer

  		




  
  5
  
    
#

  		




  
  6
  
    
# This program is free software: you can redistribute it and/or modify

  		




  
  7
  
    
# it under the terms of the GNU General Public License as published by

  		




  
  8
  
    
# the Free Software Foundation, either version 3 of the License, or

  		




  
  9
  
    
# (at your option) any later version.

  		




  
  10
  
    
#

  		




  
  11
  
    
# This program is distributed in the hope that it will be useful,

  		




  
  12
  
    
# but WITHOUT ANY WARRANTY; without even the implied warranty of

  		




  
  13
  
    
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the

  		




  
  14
  
    
# GNU General Public License for more details.

  		




  
  15
  
    
#

  		




  
  16
  
    
# You should have received a copy of the GNU General Public License

  		




  
  17
  
    
# along with this program.  If not, see <http://www.gnu.org/licenses/>.

  		




  
  18
  
    
#

  		




  
  19
  
    
# As a special exception, the above copyright owner gives unlimited

  		




  
  20
  
    
# permission to copy, distribute and modify this Makefile.am template.

  		




  
  21
  
    
# You need not follow the terms of the GNU General Public License when

  		




  
  22
  
    
# using or distributing such Makefile.am files, even though portions of

  		




  
  23
  
    
# the text of the Makefile.am appear in them. The GNU General Public

  		




  
  24
  
    
# License (GPL) does govern all other use of the material that constitutes

  		




  
  25
  
    
# the Makefile.am template.

  		




  6
  26
  
    

  		




  7
  27
  
    
# This is a blank Makefile.am for using gtk-doc.

  		




  8
  28
  
    
# Copy this to your project's API docs directory and modify the variables to

  		




  ......




  15
  35
  
    
# Uncomment for versioned docs and specify the version of the module, e.g. '2'.

  		




  16
  36
  
    
#DOC_MODULE_VERSION=2

  		




  17
  37
  
    

  		




  
  38
  
    
# The top-level XML file.

  		




  
  39
  
    
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.xml

  		




  18
  40
  
    

  		




  19
  
  
    
# The top-level SGML file. You can change this if you want to.

  		




  20
  
  
    
DOC_MAIN_SGML_FILE=$(DOC_MODULE)-docs.sgml

  		




  21
  41
  
    

  		




  22
  42
  
    
# The directory containing the source code. Relative to $(srcdir).

  		




  23
  43
  
    
# gtk-doc will search all .c & .h files beneath here for inline comments

  		




  ......




  32
  52
  
    
# e.g. SCAN_OPTIONS=--deprecated-guards="GTK_DISABLE_DEPRECATED"

  		




  33
  53
  
    
SCAN_OPTIONS=--ignore-decorators=LASSO_EXPORT

  		




  34
  54
  
    

  		




  35
  
  
    
# Extra options to supply to gtkdoc-mkdb.

  		




  36
  
  
    
# e.g. MKDB_OPTIONS=--sgml-mode --output-format=xml

  		




  37
  
  
    
MKDB_OPTIONS=--sgml-mode --output-format=xml

  		




  38
  55
  
    

  		




  
  56
  
    
# Extra options to supply to gtkdoc-mkdb

  		




  39
  57
  
    
# Extra options to supply to gtkdoc-mktmpl

  		




  40
  58
  
    
# e.g. MKTMPL_OPTIONS=--only-section-tmpl

  		




  41
  59
  
    
MKTMPL_OPTIONS=

  		




  
  60
  
    
# e.g. MKDB_OPTIONS=--xml-mode --output-format=xml

  		




  
  61
  
    
MKDB_OPTIONS=--xml-mode --output-format=xml

  		




  42
  62
  
    

  		




  43
  63
  
    
# Extra options to supply to gtkdoc-mkhtml

  		




  44
  64
  
    
MKHTML_OPTIONS=--path=$(shell pwd)

  		












  

    
        docs/reference/lasso/lasso-docs.sgml →
      docs/reference/lasso/lasso-docs.xml
    
  





  2
  2
  
    
<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"

  		




  3
  3
  
    
               "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"

  		




  4
  4
  
    
[

  		




  5
  
  
    
<!ENTITY version SYSTEM "version.xml">

  		




  6
  
  
    
<!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">

  		




  
  5
  
    
  <!ENTITY % local.common.attrib "xmlns:xi  CDATA  #FIXED 'http://www.w3.org/2003/XInclude'">

  		




  
  6
  
    
  <!ENTITY % gtkdocentities SYSTEM "xml/gtkdocentities.ent">

  		




  
  7
  
    
  %gtkdocentities;

  		




  7
  8
  
    
]>

  		




  8
  
  
    
<book id="index">

  		




  
  9
  
    
<book id="index" xmlns:xi="http://www.w3.org/2003/XInclude">

  		




  9
  10
  
    
  <bookinfo>

  		




  10
  
  
    
    <title>Lasso Reference Manual</title>

  		




  11
  
  
    
    <releaseinfo>for Lasso &version;</releaseinfo>

  		




  
  11
  
    
    <title>&package_name; Reference Manual</title>

  		




  
  12
  
    
    <releaseinfo>

  		




  
  13
  
    
      for &package_string;.

  		




  12
  14
  
    
      The latest version of this documentation can be found on-line at

  		




  13
  15
  
    
      <ulink role="online-location" url="http://lasso.entrouvert.org/documentation/index.html">http://lasso.entrouvert.org/documentation/index.html</ulink>.

  		




  
  16
  
    
    </releaseinfo>

  		




  
  17
  
    

  		




  14
  18
  
    
    <legalnotice>

  		




  15
  19
  
    
      <para>

  		




  16
  20
  
    
        Permission is granted to copy, distribute and/or modify this document

  		




  ......




  537
  541
  
    
    <xi:include href="xml/ws_strings.xml"/>

  		




  538
  542
  
    
  </chapter>

  		




  539
  543
  
    
  </reference>

  		




  540
  
  
    
  <part label="II">

  		




  541
  
  
    
  <title>Appendix</title>

  		




  542
  
  
    
  <index id="api-index">

  		




  543
  
  
    
  <title>API Index</title>

  		




  
  544
  
    

  		




  
  545
  
    
  <index id="api-index-full">

  		




  
  546
  
    
    <title>API Index</title>

  		




  
  547
  
    
    <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include>

  		




  
  548
  
    
  </index>

  		




  
  549
  
    

  		




  
  550
  
    
  <index id="deprecated-api-index" role="deprecated">

  		




  
  551
  
    
    <title>Index of deprecated API</title>

  		




  
  552
  
    
    <xi:include href="xml/api-index-deprecated.xml"><xi:fallback /></xi:include>

  		




  
  553
  
    
  </index>

  		




  
  554
  
    

  		




  
  555
  
    
  <index id="api-index-2-3" role="2.3">

  		




  
  556
  
    
    <title>Index of new API in 2.3</title>

  		




  
  557
  
    
    <xi:include href="xml/api-index-2.3.xml"><xi:fallback /></xi:include>

  		




  544
  558
  
    
  </index>

  		




  545
  
  
    
  <xi:include href="xml/annotation-glossary.xml">

  		




  546
  
  
    
    <xi:fallback/>

  		




  547
  
  
    
  </xi:include>

  		




  548
  
  
    
  </part>

  		




  
  559
  
    
  <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include>

  		




  549
  560
  
    
</book>

  		




  550
  
  
    
-