[65669e5] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
| 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
|
---|
| 3 | "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
|
---|
| 4 | <!ENTITY % general-entities SYSTEM "../../general.ent">
|
---|
| 5 | %general-entities;
|
---|
| 6 |
|
---|
| 7 | <!ENTITY valadoc-download-http
|
---|
| 8 | "https://github.com/GNOME/valadoc/archive/master.zip">
|
---|
| 9 | <!ENTITY valadoc-download-ftp " ">
|
---|
| 10 | <!ENTITY valadoc-md5sum "589b9ed644dee3c0aaaf847eaac0f50d">
|
---|
| 11 | <!ENTITY valadoc-size "408 KB">
|
---|
| 12 | <!ENTITY valadoc-buildsize "52 MB">
|
---|
| 13 | <!ENTITY valadoc-time "1.8 SBU">
|
---|
| 14 | ]>
|
---|
| 15 |
|
---|
| 16 | <sect1 id="valadoc" xreflabel="valadoc-&valadoc-version;">
|
---|
| 17 | <?dbhtml filename="valadoc.html"?>
|
---|
| 18 |
|
---|
| 19 | <sect1info>
|
---|
| 20 | <othername>$LastChangedBy$</othername>
|
---|
| 21 | <date>$Date$</date>
|
---|
| 22 | </sect1info>
|
---|
| 23 |
|
---|
| 24 | <title>valadoc-&valadoc-version;</title>
|
---|
| 25 |
|
---|
| 26 | <indexterm zone="valadoc">
|
---|
| 27 | <primary sortas="a-valadoc">valadoc</primary>
|
---|
| 28 | </indexterm>
|
---|
| 29 |
|
---|
| 30 | <sect2 role="package">
|
---|
| 31 | <title>Introduction to ValaDoc </title>
|
---|
| 32 |
|
---|
| 33 | <para>
|
---|
| 34 | The <application>Vala Docs</application> is a documentation generator for generating API documentation
|
---|
| 35 | from Vala source code based on libvala.
|
---|
| 36 | </para>
|
---|
| 37 |
|
---|
| 38 | &lfs75_checked;
|
---|
| 39 |
|
---|
| 40 | <bridgehead renderas="sect3">Package Information</bridgehead>
|
---|
| 41 | <itemizedlist spacing="compact">
|
---|
| 42 | <listitem>
|
---|
| 43 | <para>
|
---|
| 44 | Download (HTTP): <ulink url="&valadoc-download-http;"/>
|
---|
| 45 | </para>
|
---|
| 46 | </listitem>
|
---|
| 47 | <listitem>
|
---|
| 48 | <para>
|
---|
| 49 | Download (FTP): <ulink url="&valadoc-download-ftp;"/>
|
---|
| 50 | </para>
|
---|
| 51 | </listitem>
|
---|
| 52 | <listitem>
|
---|
| 53 | <para>
|
---|
| 54 | Download MD5 sum: &valadoc-md5sum;
|
---|
| 55 | </para>
|
---|
| 56 | </listitem>
|
---|
| 57 | <listitem>
|
---|
| 58 | <para>
|
---|
| 59 | Download size: &valadoc-size;
|
---|
| 60 | </para>
|
---|
| 61 | </listitem>
|
---|
| 62 | <listitem>
|
---|
| 63 | <para>
|
---|
| 64 | Estimated disk space required: &valadoc-buildsize;
|
---|
| 65 | </para>
|
---|
| 66 | </listitem>
|
---|
| 67 | <listitem>
|
---|
| 68 | <para>
|
---|
| 69 | Estimated build time: &valadoc-time;
|
---|
| 70 | </para>
|
---|
| 71 | </listitem>
|
---|
| 72 | </itemizedlist>
|
---|
| 73 |
|
---|
| 74 | <bridgehead renderas="sect3">Vala Docs Dependencies</bridgehead>
|
---|
| 75 |
|
---|
| 76 | <bridgehead renderas="sect4">Required</bridgehead>
|
---|
| 77 | <para role="required">
|
---|
| 78 | <xref linkend="libgee"/>,
|
---|
| 79 | <xref linkend="unzip"/>, (to extract source)
|
---|
| 80 | <xref linkend="gdk-pixbuf"/>, and
|
---|
| 81 | <xref linkend ="graphviz"/>
|
---|
| 82 | </para>
|
---|
| 83 |
|
---|
| 84 | <para condition="html" role="usernotes">User Notes:
|
---|
| 85 | <ulink url="&blfs-wiki;/valadoc"/>
|
---|
| 86 | </para>
|
---|
| 87 | </sect2>
|
---|
| 88 |
|
---|
| 89 | <sect2 role="installation">
|
---|
| 90 | <title>Installation of Vala Docs</title>
|
---|
| 91 |
|
---|
| 92 | <para>
|
---|
| 93 | Install <application>Vala Docs</application> by running
|
---|
| 94 | the following commands:
|
---|
| 95 | </para>
|
---|
| 96 |
|
---|
| 97 | <screen><userinput>./configure --prefix=/usr &&
|
---|
| 98 | make</userinput></screen>
|
---|
| 99 |
|
---|
| 100 | <para>
|
---|
| 101 | This package does not come with a test suite.
|
---|
| 102 | </para>
|
---|
| 103 |
|
---|
| 104 | <para>
|
---|
| 105 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 106 | </para>
|
---|
| 107 |
|
---|
| 108 | <screen role="root"><userinput>make install</userinput></screen>
|
---|
| 109 |
|
---|
| 110 | </sect2>
|
---|
| 111 |
|
---|
| 112 | <sect2 role="commands">
|
---|
| 113 | <title>Command Explanations</title>
|
---|
| 114 |
|
---|
| 115 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 116 | href="../../xincludes/without-scrollkeeper.xml"/>
|
---|
| 117 |
|
---|
| 118 | </sect2>
|
---|
| 119 |
|
---|
| 120 | <sect2 role="content">
|
---|
| 121 | <title>Contents</title>
|
---|
| 122 |
|
---|
| 123 | <segmentedlist>
|
---|
| 124 | <segtitle>Installed Directories</segtitle>
|
---|
| 125 |
|
---|
| 126 | <seglistitem>
|
---|
| 127 | <seg>
|
---|
| 128 | /usr/share/gnome/help/{accessibility-devel-guide,gnome-devel-demos},
|
---|
| 129 | /usr/share/gnome/help/{hig-book,integration-guide} and
|
---|
| 130 | /usr/share/gnome/help/{optimization-guide,platform-overview}
|
---|
| 131 | </seg>
|
---|
| 132 | </seglistitem>
|
---|
| 133 | </segmentedlist>
|
---|
| 134 |
|
---|
| 135 | </sect2>
|
---|
| 136 |
|
---|
| 137 | </sect1>
|
---|