Changeset fdca4266 for gnome/core/gtk-doc.xml
- Timestamp:
- 06/15/2004 04:33:15 AM (20 years ago)
- Branches:
- 10.0, 10.1, 11.0, 11.1, 11.2, 11.3, 12.0, 12.1, 6.0, 6.1, 6.2, 6.2.0, 6.2.0-rc1, 6.2.0-rc2, 6.3, 6.3-rc1, 6.3-rc2, 6.3-rc3, 7.10, 7.4, 7.5, 7.6, 7.6-blfs, 7.6-systemd, 7.7, 7.8, 7.9, 8.0, 8.1, 8.2, 8.3, 8.4, 9.0, 9.1, basic, bdubbs/svn, elogind, gnome, kde5-13430, kde5-14269, kde5-14686, kea, ken/TL2024, ken/inkscape-core-mods, ken/tuningfonts, krejzi/svn, lazarus, lxqt, nosym, perl-modules, plabs/newcss, plabs/python-mods, python3.11, qt5new, rahul/power-profiles-daemon, renodr/vulkan-addition, systemd-11177, systemd-13485, trunk, upgradedb, xry111/intltool, xry111/llvm18, xry111/soup3, xry111/test-20220226, xry111/xf86-video-removal
- Children:
- f3a7922
- Parents:
- 9d2dc4e2
- File:
-
- 1 edited
Legend:
- Unmodified
- Added
- Removed
-
gnome/core/gtk-doc.xml
r9d2dc4e2 rfdca4266 1 <?xml version="1.0" encoding="ISO-8859-1"?> 2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" 3 "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [ 4 <!ENTITY % general-entities SYSTEM "../../general.ent"> 5 %general-entities; 6 7 <!ENTITY gtk-doc-download-http "http://ftp.gnome.org/pub/GNOME/sources/gtk-doc/1.2/gtk-doc->k-doc-version;.tar.bz2"> 8 <!ENTITY gtk-doc-download-ftp "ftp://ftp.gnome.org/pub/GNOME/sources/gtk-doc/1.2/gtk-doc->k-doc-version;.tar.bz2"> 9 <!ENTITY gtk-doc-size "132 KB"> 10 <!ENTITY gtk-doc-buildsize "1092 KB"> 11 <!ENTITY gtk-doc-time "0.01 SBU"> 12 13 ]> 14 1 15 <sect1 id="gtk-doc" xreflabel="GTK-Doc->k-doc-version;"> 2 16 <?dbhtml filename="gtk-doc.html"?> 3 17 <title>GTK-Doc->k-doc-version;</title> 4 18 5 >k-doc-intro; 6 >k-doc-inst; 7 >k-doc-desc; 19 <sect2> 20 <title>Introduction to <application><acronym>GTK</acronym>-Doc</application></title> 21 22 <para>The <application><acronym>GTK</acronym>-Doc</application> package contains a code documentor. This is useful for 23 extracting specially formatted comments from the code to create 24 <acronym>API</acronym> 25 documentation. This package is <emphasis>optional</emphasis>; if it is not 26 installed, packages will not build the documentation. This does not mean 27 that you will not have any documentation. If <application><acronym>GTK</acronym>-Doc</application> is not available, the 28 install process will copy pre-built documentation to your system. 29 </para> 30 31 <sect3><title>Package information</title> 32 <itemizedlist spacing='compact'> 33 <listitem><para>Download (HTTP): <ulink 34 url=">k-doc-download-http;"/></para></listitem> 35 <listitem><para>Download (FTP): <ulink 36 url=">k-doc-download-ftp;"/></para></listitem> 37 <listitem><para>Download size: >k-doc-size;</para></listitem> 38 <listitem><para>Estimated Disk space required: 39 >k-doc-buildsize;</para></listitem> 40 <listitem><para>Estimated build time: 41 >k-doc-time;</para></listitem></itemizedlist> 42 </sect3> 43 44 <!-- <sect3><title>Additional downloads:</title> 45 <itemizedlist spacing='compact'> 46 <listitem><para>Required download:</para></listitem> 47 <listitem><para><ulink 48 url="http://www.labs.redhat.com/png/png-support-3.1.dtd">png-support-3.1.dtd</ulink></para></listitem></itemizedlist></sect3> --> 49 50 <sect3><title><application><application><acronym>GTK</acronym>-Doc</application></application> dependencies</title> 51 <sect4><title>Required</title> 52 <para> 53 <xref linkend="openjade"/>, 54 <xref linkend="libxslt"/>, 55 <xref linkend="DocBook"/> and 56 <xref linkend="docbook-xsl"/> 57 <!-- 58 <xref linkend="sgml-dtd-3"/>, 59 <xref linkend="sgml-dtd"/> and 60 <xref linkend="docbook-dsssl"/> 61 --> 62 </para></sect4> 63 </sect3> 64 65 </sect2> 66 67 <sect2> 68 <title>Installation of <application><acronym>GTK</acronym>-Doc</application></title> 69 70 <para>Install <application><acronym>GTK</acronym>-Doc</application> by running the following commands:</para> 71 72 <screen><userinput><command>./configure --prefix=/usr && 73 make install</command></userinput></screen> 74 75 <!-- <para>You should either save <filename>png-support-3.1.dtd</filename> to 76 <filename>/usr/share/sgml/docbook/sgml-dtd-3.1</filename> or move the 77 file to that location. Some configuration steps need to be performed 78 that are listed at <xref linkend="sgml-dtd-3"/>.</para> --> 79 80 </sect2> 81 82 <sect2> 83 <title>Contents</title> 84 85 <para>The <application><acronym>GTK</acronym>-Doc</application> package contains 86 <command>gtkdoc-fixxref</command>, 87 <command>gtkdoc-mkdb</command>, 88 <command>gtkdoc-mkhtml</command>, 89 <command>gtkdoc-mkman</command>, 90 <command>gtkdoc-mktmpl</command>, 91 <command>gtkdoc-scan</command>, 92 <command>gtkdoc-scangobj</command>, 93 <command>gtkdoc-scanobj</command> and 94 <command>gtkdocize</command>. 95 </para> 96 97 </sect2> 98 99 <sect2><title>Description</title> 100 101 <para>These are all <application>Perl</application> scripts used by 102 <filename>Makefile</filename> scripts to generate 103 documentation for the package.</para> 104 105 </sect2> 8 106 9 107 </sect1>
Note:
See TracChangeset
for help on using the changeset viewer.