source: gnome/platform/valadoc.xml@ 65669e5

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
   "http://www.oasis-open.org/docbook/xml/4.5/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../../general.ent">
  %general-entities;

  <!ENTITY valadoc-download-http
           "https://github.com/GNOME/valadoc/archive/master.zip">
  <!ENTITY valadoc-download-ftp " ">
  <!ENTITY valadoc-md5sum        "589b9ed644dee3c0aaaf847eaac0f50d">
  <!ENTITY valadoc-size          "408 KB">
  <!ENTITY valadoc-buildsize     "52 MB">
  <!ENTITY valadoc-time          "1.8 SBU">
]>

<sect1 id="valadoc" xreflabel="valadoc-&valadoc-version;">
  <?dbhtml filename="valadoc.html"?>

  <sect1info>
    <othername>$LastChangedBy$</othername>
    <date>$Date$</date>
  </sect1info>

  <title>valadoc-&valadoc-version;</title>

  <indexterm zone="valadoc">
    <primary sortas="a-valadoc">valadoc</primary>
  </indexterm>

  <sect2 role="package">
    <title>Introduction to ValaDoc </title>

    <para>
      The <application>Vala Docs</application> is a documentation generator for generating API documentation 
      from Vala source code based on libvala. 
    </para>

    &lfs75_checked;

    <bridgehead renderas="sect3">Package Information</bridgehead>
    <itemizedlist spacing="compact">
      <listitem>
        <para>
          Download (HTTP): <ulink url="&valadoc-download-http;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download (FTP): <ulink url="&valadoc-download-ftp;"/>
        </para>
      </listitem>
      <listitem>
        <para>
          Download MD5 sum: &valadoc-md5sum;
        </para>
      </listitem>
      <listitem>
        <para>
          Download size: &valadoc-size;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated disk space required: &valadoc-buildsize;
        </para>
      </listitem>
      <listitem>
        <para>
          Estimated build time: &valadoc-time;
        </para>
      </listitem>
    </itemizedlist>

    <bridgehead renderas="sect3">Vala Docs Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="libgee"/>,
      <xref linkend="unzip"/>,  (to extract source)
      <xref linkend="gdk-pixbuf"/>, and
      <xref linkend ="graphviz"/>
    </para>

    <para condition="html" role="usernotes">User Notes:
      <ulink url="&blfs-wiki;/valadoc"/>
    </para>
  </sect2>

  <sect2 role="installation">
    <title>Installation of Vala Docs</title>

    <para>
      Install <application>Vala Docs</application> by running
      the following commands:
    </para>

<screen><userinput>./configure --prefix=/usr &amp;&amp;
make</userinput></screen>

    <para>
      This package does not come with a test suite.
    </para>

    <para>
      Now, as the <systemitem class="username">root</systemitem> user:
    </para>

<screen role="root"><userinput>make install</userinput></screen>

  </sect2>

  <sect2 role="commands">
    <title>Command Explanations</title>

    <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
      href="../../xincludes/without-scrollkeeper.xml"/>

  </sect2>

  <sect2 role="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          /usr/share/gnome/help/{accessibility-devel-guide,gnome-devel-demos},
          /usr/share/gnome/help/{hig-book,integration-guide} and
          /usr/share/gnome/help/{optimization-guide,platform-overview}
        </seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

</sect1>