[ab4fdfc] | 1 | <?xml version="1.0" encoding="UTF-8"?>
|
---|
[622cc86e] | 2 | <!DOCTYPE sect2 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 doxyqml-download-http "https://files.pythonhosted.org/packages/source/d/doxyqml/doxyqml-&doxyqml-version;.tar.gz">
|
---|
| 8 | <!ENTITY doxyqml-download-ftp " ">
|
---|
[569925c7] | 9 | <!ENTITY doxyqml-md5sum "&doxyqml-md5sum;">
|
---|
[9dfe7f2] | 10 | <!ENTITY doxyqml-size "28 KB">
|
---|
[7d70bd4b] | 11 | <!ENTITY doxyqml-buildsize "652 KB (with tests)">
|
---|
[72c62e4] | 12 | <!ENTITY doxyqml-time "less than 0.1 SBU (with tests)">
|
---|
[622cc86e] | 13 | ]>
|
---|
| 14 |
|
---|
| 15 | <sect2 id="doxyqml" xreflabel="doxyqml-&doxyqml-version;">
|
---|
| 16 |
|
---|
| 17 | <title>Doxyqml-&doxyqml-version;</title>
|
---|
| 18 |
|
---|
| 19 | <indexterm zone="doxyqml">
|
---|
| 20 | <primary sortas="a-doxyqml">doxyqml</primary>
|
---|
| 21 | </indexterm>
|
---|
| 22 |
|
---|
| 23 | <sect3 role="package">
|
---|
| 24 | <title>Introduction to Doxyqml Module</title>
|
---|
| 25 |
|
---|
| 26 | <para>
|
---|
| 27 | The <application>Doxyqml</application> package allows using Doxygen
|
---|
| 28 | to document QML classes.
|
---|
| 29 | </para>
|
---|
| 30 |
|
---|
[f822342] | 31 | &lfs122_checked;
|
---|
[622cc86e] | 32 |
|
---|
| 33 | <bridgehead renderas="sect4">Package Information</bridgehead>
|
---|
| 34 | <itemizedlist spacing="compact">
|
---|
| 35 | <listitem>
|
---|
| 36 | <para>
|
---|
| 37 | Download (HTTP): <ulink url="&doxyqml-download-http;"/>
|
---|
| 38 | </para>
|
---|
| 39 | </listitem>
|
---|
| 40 | <listitem>
|
---|
| 41 | <para>
|
---|
| 42 | Download (FTP): <ulink url="&doxyqml-download-ftp;"/>
|
---|
| 43 | </para>
|
---|
| 44 | </listitem>
|
---|
| 45 | <listitem>
|
---|
| 46 | <para>
|
---|
| 47 | Download MD5 sum: &doxyqml-md5sum;
|
---|
| 48 | </para>
|
---|
| 49 | </listitem>
|
---|
| 50 | <listitem>
|
---|
| 51 | <para>
|
---|
| 52 | Download size: &doxyqml-size;
|
---|
| 53 | </para>
|
---|
| 54 | </listitem>
|
---|
| 55 | <listitem>
|
---|
| 56 | <para>
|
---|
| 57 | Estimated disk space required: &doxyqml-buildsize;
|
---|
| 58 | </para>
|
---|
| 59 | </listitem>
|
---|
| 60 | <listitem>
|
---|
| 61 | <para>
|
---|
| 62 | Estimated build time: &doxyqml-time;
|
---|
| 63 | </para>
|
---|
| 64 | </listitem>
|
---|
| 65 | </itemizedlist>
|
---|
| 66 |
|
---|
| 67 | <bridgehead renderas="sect4">Doxyqml Dependencies</bridgehead>
|
---|
| 68 |
|
---|
| 69 | <bridgehead renderas="sect5">Required (Run Time)</bridgehead>
|
---|
| 70 | <para role="required">
|
---|
| 71 | <xref role="runtime" linkend="doxygen"/>
|
---|
| 72 | </para>
|
---|
| 73 |
|
---|
| 74 | <bridgehead renderas="sect5">Optional (for testing)</bridgehead>
|
---|
| 75 | <para role="optional">
|
---|
| 76 | <xref linkend="pytest"/>
|
---|
| 77 | </para>
|
---|
| 78 |
|
---|
| 79 | </sect3>
|
---|
| 80 |
|
---|
| 81 | <sect3 role="installation">
|
---|
| 82 | <title>Installation of Doxyqml</title>
|
---|
| 83 |
|
---|
| 84 | <para> Build the module: </para>
|
---|
| 85 |
|
---|
[db244ae2] | 86 | &build-wheel;
|
---|
[622cc86e] | 87 |
|
---|
| 88 | <para>
|
---|
| 89 | Now, as the <systemitem class="username">root</systemitem> user:
|
---|
| 90 | </para>
|
---|
| 91 |
|
---|
[db244ae2] | 92 | <screen role="root"><userinput>&install-wheel; doxyqml</userinput></screen>
|
---|
[622cc86e] | 93 |
|
---|
| 94 | <para>
|
---|
| 95 | To test the installation, run:
|
---|
| 96 | </para>
|
---|
| 97 |
|
---|
| 98 | <screen remap="test"><userinput>pytest</userinput></screen>
|
---|
| 99 |
|
---|
| 100 | <para>
|
---|
[72c62e4] | 101 | The <emphasis>test_qmlclass.py</emphasis> test is known to fail.
|
---|
[622cc86e] | 102 | </para>
|
---|
| 103 |
|
---|
| 104 | </sect3>
|
---|
| 105 |
|
---|
| 106 | <xi:include xmlns:xi="http://www.w3.org/2001/XInclude"
|
---|
| 107 | href="../../../xincludes/pip3-cmd-explain.xml"/>
|
---|
| 108 |
|
---|
| 109 | <sect3 role="content">
|
---|
| 110 | <title>Contents</title>
|
---|
| 111 |
|
---|
| 112 | <segmentedlist>
|
---|
| 113 | <segtitle>Installed Programs</segtitle>
|
---|
| 114 | <segtitle>Installed Libraries</segtitle>
|
---|
| 115 | <segtitle>Installed Directories</segtitle>
|
---|
| 116 |
|
---|
| 117 | <seglistitem>
|
---|
| 118 | <seg>doxyqml</seg>
|
---|
| 119 | <seg>None</seg>
|
---|
| 120 | <seg>
|
---|
| 121 | /usr/lib/python&python3-majorver;/site-packages/doxyqml and
|
---|
| 122 | /usr/lib/python&python3-majorver;/site-packages/doxyqml-&doxyqml-version;.dist-info
|
---|
| 123 | </seg>
|
---|
| 124 | </seglistitem>
|
---|
| 125 | </segmentedlist>
|
---|
| 126 |
|
---|
| 127 | <variablelist>
|
---|
| 128 | <bridgehead renderas="sect5">Short Descriptions</bridgehead>
|
---|
| 129 | <?dbfo list-presentation="list"?>
|
---|
| 130 | <?dbhtml list-presentation="table"?>
|
---|
| 131 |
|
---|
| 132 | <varlistentry id="doxyqml-prog">
|
---|
| 133 | <term><command>doxyqml</command></term>
|
---|
| 134 | <listitem>
|
---|
| 135 | <para>
|
---|
| 136 | is a Doxygen input filter for QML files.
|
---|
| 137 | </para>
|
---|
| 138 | <indexterm zone="doxyqml doxyqml-prog">
|
---|
| 139 | <primary sortas="b-doxyqml-prog">doxyqml</primary>
|
---|
| 140 | </indexterm>
|
---|
| 141 | </listitem>
|
---|
| 142 | </varlistentry>
|
---|
| 143 |
|
---|
| 144 | </variablelist>
|
---|
[54d58907] | 145 |
|
---|
[622cc86e] | 146 | </sect3>
|
---|
| 147 |
|
---|
| 148 | </sect2>
|
---|