source: kde5/frameworks/kapidox.xml@ 3899973

<?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 kapidox-download-http "&kf5-download-http;/kapidox-&kf5-version;.tar.xz">
  <!ENTITY kapidox-download-ftp  "&kf5-download-ftp;/kapidox-&kf5-version;.tar.xz">
  <!ENTITY kapidox-md5sum        "682af5d0c1f01149106f28f9d82d09d9">
  <!ENTITY kapidox-size          "124 KB">
  <!ENTITY kapidox-buildsize     "1.9 MB">
  <!ENTITY kapidox-time          "less than 0.1 SBU">
]>

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

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

  <title>kapidox-&kf5-version;</title>

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

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

    <para>
      The <application>kapidox</application> package contains scripts
      and data for building API documentation (dox) in a standard
      format and style.
    </para>

    &lfs75_checked;

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

    <bridgehead renderas="sect3">kapidox Dependencies</bridgehead>

    <bridgehead renderas="sect4">Required</bridgehead>
    <para role="required">
      <xref linkend="cmake"/> and
      <xref linkend="python2"/>
    </para>

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

  <sect2 role="installation">
    <title>Installation of kapidox</title>

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

<screen><userinput>mkdir build &amp;&amp;
cd    build &amp;&amp;

cmake -DCMAKE_INSTALL_PREFIX=$KF5_PREFIX .. &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="content">
    <title>Contents</title>

    <segmentedlist>
      <segtitle>Installed Programs</segtitle>
      <segtitle>Installed Libraries</segtitle>
      <segtitle>Installed Directories</segtitle>

      <seglistitem>
        <seg>
          depdiagram-generate, depdiagram-generate-all, depdiagram-prepare,
          kgenapidox kgenframeworksapidox
        </seg>
        <seg>
          None
        </seg>
        <seg>
          $KF5_PREFIX/lib/python-&python2-majorver;/site-packages/kapidox
        </seg>
      </seglistitem>
    </segmentedlist>

  </sect2>

</sect1>