path: root/src/qdoc/qdoc/tests/validateqdocoutputfiles/testdata/comprehensiveproject/expected/docbook/qml-qdoc-test-type.xml

<?xml version="1.0" encoding="UTF-8"?>
<db:article xmlns:db="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" xmlns:its="http://www.w3.org/2005/11/its" version="5.2" xml:lang="en">
<db:info>
<db:title its:translate="no">Type QML Type</db:title>
<db:productname>Test</db:productname>
<db:titleabbrev>A test project for QDoc build artifacts</db:titleabbrev>
<db:abstract>
<db:para>A QML type documented in a .cpp file.</db:para>
<db:para>This type was introduced in Qt 1.1.</db:para>
</db:abstract>
</db:info>
<db:variablelist its:translate="no">
<db:varlistentry>
<db:term>Import Statement</db:term>
<db:listitem>
<db:para>import QDoc.Test 1.1</db:para>
</db:listitem>
</db:varlistentry>
<db:varlistentry>
<db:term>Since:</db:term>
<db:listitem>
<db:para>Qt 1.1</db:para>
</db:listitem>
</db:varlistentry>
<db:varlistentry>
<db:term>Instantiates:</db:term>
<db:listitem>
<db:para><db:link xlink:href="testqdoc-test.xml">Test</db:link></db:para>
</db:listitem>
</db:varlistentry>
<db:varlistentry>
<db:term>Status:</db:term>
<db:listitem>
<db:para>&lt;Work In Progress&gt;</db:para>
</db:listitem>
</db:varlistentry>
</db:variablelist>
<db:section xml:id="details">
<db:title>Detailed Description</db:title>
</db:section>
<db:section xml:id="property-documentation">
<db:title>Property Documentation</db:title>
<db:section xml:id="fifth-prop">
<db:title>fifth : int</db:title>
<db:fieldsynopsis>
<db:type>int</db:type>
<db:varname>fifth</db:varname>
<db:modifier>writable</db:modifier>
<db:synopsisinfo role="access">public</db:synopsisinfo>
<db:synopsisinfo role="status">active</db:synopsisinfo>
<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo>
</db:fieldsynopsis>
<db:bridgehead renderas="sect2">fourth : int</db:bridgehead><db:fieldsynopsis>
<db:type>int</db:type>
<db:varname>fourth</db:varname>
<db:modifier>writable</db:modifier>
<db:synopsisinfo role="access">public</db:synopsisinfo>
<db:synopsisinfo role="status">active</db:synopsisinfo>
<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo>
</db:fieldsynopsis>
<db:para>A group of properties sharing a documentation comment.</db:para>
</db:section>
<db:section xml:id="group-prop">
<db:title>group group</db:title>
<db:bridgehead renderas="sect2" xml:id="group.first-prop">group.first : int</db:bridgehead>
<db:fieldsynopsis>
<db:type>int</db:type>
<db:varname>group.first</db:varname>
<db:modifier>writable</db:modifier>
<db:synopsisinfo role="access">public</db:synopsisinfo>
<db:synopsisinfo role="status">active</db:synopsisinfo>
<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo>
</db:fieldsynopsis>
<db:bridgehead renderas="sect2" xml:id="group.second-prop">group.second : int</db:bridgehead>
<db:fieldsynopsis>
<db:type>int</db:type>
<db:varname>group.second</db:varname>
<db:modifier>writable</db:modifier>
<db:synopsisinfo role="access">public</db:synopsisinfo>
<db:synopsisinfo role="status">active</db:synopsisinfo>
<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo>
</db:fieldsynopsis>
<db:bridgehead renderas="sect2" xml:id="group.third-prop">group.third : int</db:bridgehead>
<db:fieldsynopsis>
<db:type>int</db:type>
<db:varname>group.third</db:varname>
<db:modifier>writable</db:modifier>
<db:synopsisinfo role="access">public</db:synopsisinfo>
<db:synopsisinfo role="status">active</db:synopsisinfo>
<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo>
</db:fieldsynopsis>
<db:para>A property group.</db:para>
</db:section>
<db:section xml:id="id-prop">
<db:title>[read-only] id : int</db:title>
<db:fieldsynopsis>
<db:type>int</db:type>
<db:varname>id</db:varname>
<db:modifier>[read-only]</db:modifier>

<db:synopsisinfo role="access">public</db:synopsisinfo>
<db:synopsisinfo role="status">active</db:synopsisinfo>
<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo>
</db:fieldsynopsis>
<db:para>A read-only property.</db:para>
</db:section>
<db:section xml:id="name-prop">
<db:title>[required] name : string</db:title>
<db:fieldsynopsis>
<db:type>string</db:type>
<db:varname>name</db:varname>
<db:modifier>writable</db:modifier>
<db:modifier>required</db:modifier>
<db:synopsisinfo role="access">public</db:synopsisinfo>
<db:synopsisinfo role="status">active</db:synopsisinfo>
<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo>
</db:fieldsynopsis>
<db:para>Name of the Test.</db:para>
</db:section>
</db:section>
<db:section xml:id="attached-property-documentation">
<db:title>Attached Property Documentation</db:title>
<db:section xml:id="type-attached-prop">
<db:title>[default: Type.NoType] Type.type : enumeration</db:title>
<db:fieldsynopsis>
<db:type>enumeration</db:type>
<db:varname>Type.type</db:varname>
<db:modifier>attached</db:modifier>
<db:modifier>writable</db:modifier>
<db:synopsisinfo role="access">public</db:synopsisinfo>
<db:synopsisinfo role="status">active</db:synopsisinfo>
<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo>
</db:fieldsynopsis>
<db:informaltable>
<db:thead>
<db:tr>
<db:th>Constant</db:th>
<db:th>Description</db:th>
</db:tr>
</db:thead>
<db:tr>
<db:td>
<db:para its:translate="no">Type.NoType</db:para>
</db:td>
<db:td>
<db:para>Nothing</db:para>
</db:td>
</db:tr>
<db:tr>
<db:td>
<db:para its:translate="no">Type.SomeType</db:para>
</db:td>
<db:td>
<db:para>Something</db:para>
</db:td>
</db:tr>
</db:informaltable>
</db:section>
</db:section>
<db:section xml:id="signal-documentation">
<db:title>Signal Documentation</db:title>
<db:section xml:id="completed-signal">
<db:title>completed(int <db:emphasis>status</db:emphasis>)</db:title>
<db:para>This signal is emitted when the operation completed with <db:code its:translate="no" role="parameter">status</db:code>.</db:para>
<db:note>
<db:para>The corresponding handler is <db:code>onCompleted</db:code>.</db:para>
</db:note>
</db:section>
<db:section xml:id="group.created-signal">
<db:title>group.created()</db:title>
<db:para>This signal is prefixed with <db:emphasis>group</db:emphasis>.</db:para>
<db:note>
<db:para>The corresponding handler is <db:code>group.onCreated</db:code>.</db:para>
</db:note>
</db:section>
</db:section>
<db:section xml:id="attached-signal-documentation">
<db:title>Attached Signal Documentation</db:title>
<db:section xml:id="configured-signal">
<db:title>configured()</db:title>
<db:para>This attached signal is emitted when the type was configured.</db:para>
<db:note>
<db:para>The corresponding handler is <db:code>onConfigured</db:code>.</db:para>
</db:note>
</db:section>
</db:section>
<db:section xml:id="method-documentation">
<db:title>Method Documentation</db:title>
<db:section xml:id="disable-method">
<db:title>disable()</db:title>
<db:methodsynopsis>
<db:type></db:type>
<db:methodname>disable</db:methodname>
<db:void/>
<db:synopsisinfo role="meta">qmlmethod</db:synopsisinfo>
<db:synopsisinfo role="signature">disable()</db:synopsisinfo>
<db:synopsisinfo role="access">public</db:synopsisinfo>
<db:synopsisinfo role="status">active</db:synopsisinfo>
<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo>
</db:methodsynopsis>
<db:bridgehead renderas="sect2">enable()</db:bridgehead><db:methodsynopsis>
<db:type></db:type>
<db:methodname>enable</db:methodname>
<db:void/>
<db:synopsisinfo role="meta">qmlmethod</db:synopsisinfo>
<db:synopsisinfo role="signature">enable()</db:synopsisinfo>
<db:synopsisinfo role="access">public</db:synopsisinfo>
<db:synopsisinfo role="status">active</db:synopsisinfo>
<db:synopsisinfo role="threadsafeness">unspecified</db:synopsisinfo>
</db:methodsynopsis>
<db:para>Enables or disables this type.</db:para>
</db:section>
<db:section xml:id="copy-method">
<db:title>Type copy(<db:emphasis>a</db:emphasis>)</db:title>
<db:para>Returns another Type based on <db:code its:translate="no" role="parameter">a</db:code>.</db:para>
</db:section>
<db:section xml:id="futureDeprecated-method">
<db:title>[until 6.3] futureDeprecated()</db:title>
<db:para>This method is scheduled for deprecation in version 6.3.</db:para>
<db:para>Use something else instead.</db:para>
<db:para>This is a method that's marked for deprecation in a future version.</db:para>
</db:section>
</db:section>
<db:section xml:id="obsolete">
<db:title>Obsolete Members for Type</db:title>
<db:para><db:emphasis role="bold">The following members of QML type <db:link xlink:href="qml-qdoc-test-type.xml">Type</db:link> are deprecated.</db:emphasis> We strongly advise against using them in new code.</db:para>
<db:section xml:id="obsolete-method-documentation">
<db:title>Obsolete Method Documentation</db:title>
<db:section xml:id="deprecatedMethod-method">
<db:title>[deprecated in 6.2] deprecatedMethod()</db:title>
<db:para>This method is deprecated since QDoc.Test 6.2. We strongly advise against using it in new code.</db:para>
<db:para>This method has no replacement.</db:para>
<db:para>This is a method that should include information about being deprecated and that it has been so since 6.2 in its docs.</db:para>
</db:section>
</db:section>
</db:section>
</db:article>