Subject : Missing reference for content part (See attached image).

NB : All xml copied from ditaxml_4.7_snapshot_20111110

Take a look and compate "CONTENT" area on following pages

http://doc.qt.nokia.com/4.8-snapshot/qabstractbutton.html
http://developer.qt.nokia.com/doc/qt-4.7/qabstractbutton.html

"Protected Functions" is missing on "developer.qt.nokia.com"

if you look at "qabstractbutton.xml" (source)

Aroud line 191 : under "<section outputclass="redundant">"

 <p outputclass="protected-functions h2">Protected Functions</p>

This line has "protected-functions" property, which should be also part of following functions in qabstractbutton.xml

Around line 599 :

    <cxxFunction id="id-4dfa361a-8f2d-4a8e-acb3-f835be6b8c3d">
        <apiName>checkStateSet</apiName>
        <cxxFunctionDetail>
            <cxxFunctionDefinition>
                <cxxFunctionAccessSpecifier value="protected"/>
                <cxxFunctionVirtual name="virtual" value="virtual"/>
                <cxxFunctionDeclaredType>void</cxxFunctionDeclaredType>
                <cxxFunctionScopedName>QAbstractButton</cxxFunctionScopedName>
                <cxxFunctionPrototype>void checkStateSet()</cxxFunctionPrototype>
                <cxxFunctionNameLookup>QAbstractButton::checkStateSet()</cxxFunctionNameLookup>
                <cxxFunctionAPIItemLocation>
                    <cxxFunctionDeclarationFile name="filePath" value="/Users/casper/Development/Qt/mainline/src/gui/widgets/qabstractbutton.h"/>
                    <cxxFunctionDeclarationFileLine name="lineNumber" value="133"/>
                </cxxFunctionAPIItemLocation>
            </cxxFunctionDefinition>
            <apiDesc>
                <p>This virtual handler is called when <xref href="qabstractbutton.xml#id-190f2445-1c19-496a-944f-39fd254631cc">setChecked</xref>() was called, unless it was called from within <xref href="qabstractbutton.xml#id-4e4fac93-053e-44c8-88b3-be37f91a2a54">nextCheckState</xref>(). It allows subclasses to reset their intermediate button states.</p>
                <p>
                    <b>See also </b>
                    <xref href="qabstractbutton.xml#id-4e4fac93-053e-44c8-88b3-be37f91a2a54">nextCheckState</xref>().</p>
            </apiDesc>
        </cxxFunctionDetail>
    </cxxFunction>

Around line 790 :

 <cxxFunction id="id-ad73478e-cd49-44d6-b341-cff959b114a9">
        <apiName>hitButton</apiName>
        <cxxFunctionDetail>
            <cxxFunctionDefinition>
                <cxxFunctionAccessSpecifier value="protected"/>
                <cxxFunctionConst name="const" value="const"/>
                <cxxFunctionVirtual name="virtual" value="virtual"/>
                <cxxFunctionDeclaredType>
                    <apiRelation href="qml-bool.xml">bool</apiRelation>
                </cxxFunctionDeclaredType>
                <cxxFunctionScopedName>QAbstractButton</cxxFunctionScopedName>
                <cxxFunctionPrototype>bool hitButton(const QPoint &amp;pos)</cxxFunctionPrototype>
                <cxxFunctionNameLookup>QAbstractButton::hitButton(const QPoint &amp;pos)</cxxFunctionNameLookup>
                <cxxFunctionParameters>
                    <cxxFunctionParameter>
                        <cxxFunctionParameterDeclaredType>const <apiRelation href="qpoint.xml">QPoint</apiRelation> &amp;</cxxFunctionParameterDeclaredType>
                        <cxxFunctionParameterDeclarationName>pos</cxxFunctionParameterDeclarationName>
                    </cxxFunctionParameter>
                </cxxFunctionParameters>
                <cxxFunctionAPIItemLocation>
                    <cxxFunctionDeclarationFile name="filePath" value="/Users/casper/Development/Qt/mainline/src/gui/widgets/qabstractbutton.h"/>
                    <cxxFunctionDeclarationFileLine name="lineNumber" value="132"/>
                </cxxFunctionAPIItemLocation>
            </cxxFunctionDefinition>
            <apiDesc>
                <p>Returns true if <i>pos</i> is inside the clickable button rectangle; otherwise returns false.</p>
                <p>By default, the clickable area is the entire widget. Subclasses may reimplement this function to provide support for clickable areas of different shapes and sizes.</p>
            </apiDesc>
        </cxxFunctionDetail>
    </cxxFunction>

Around line : 960

    <cxxFunction id="id-4e4fac93-053e-44c8-88b3-be37f91a2a54">
        <apiName>nextCheckState</apiName>
        <cxxFunctionDetail>
            <cxxFunctionDefinition>
                <cxxFunctionAccessSpecifier value="protected"/>
                <cxxFunctionVirtual name="virtual" value="virtual"/>
                <cxxFunctionDeclaredType>void</cxxFunctionDeclaredType>
                <cxxFunctionScopedName>QAbstractButton</cxxFunctionScopedName>
                <cxxFunctionPrototype>void nextCheckState()</cxxFunctionPrototype>
                <cxxFunctionNameLookup>QAbstractButton::nextCheckState()</cxxFunctionNameLookup>
                <cxxFunctionAPIItemLocation>
                    <cxxFunctionDeclarationFile name="filePath" value="/Users/casper/Development/Qt/mainline/src/gui/widgets/qabstractbutton.h"/>
                    <cxxFunctionDeclarationFileLine name="lineNumber" value="134"/>
                </cxxFunctionAPIItemLocation>
            </cxxFunctionDefinition>
            <apiDesc>
                <p>This virtual handler is called when a button is clicked. The default implementation calls setChecked(!<xref href="qabstractbutton.xml#id-190f2445-1c19-496a-944f-39fd254631cc">isChecked</xref>()) if the button <xref href="qabstractbutton.xml#id-cd8b89ee-f920-4056-ab23-fd6dd0d5b4ad">isCheckable</xref>(). It allows subclasses to implement intermediate button states.</p>
                <p>
                    <b>See also </b>
                    <xref href="qabstractbutton.xml#id-4dfa361a-8f2d-4a8e-acb3-f835be6b8c3d">checkStateSet</xref>().</p>
            </apiDesc>
        </cxxFunctionDetail>
    </cxxFunction>

I would like to fix above issue by applying patch :

index e0b180b..e7a8c08 100644
--- a/dita/ditaxml_4_7_snapshot_20111110/qabstractbutton.xml
+++ b/dita/ditaxml_4_7_snapshot_20111110/qabstractbutton.xml
@@ -597,7 +597,7 @@ button-&gt;setShortcut&lt;/@func&gt;(tr(&quot;Alt+F7&quot;));</codeblock>
         </cxxFunctionDetail>
     </cxxFunction>
     <cxxFunction id="id-4dfa361a-8f2d-4a8e-acb3-f835be6b8c3d">
-        <apiName>checkStateSet</apiName>
+        <apiName class="protected-functions">checkStateSet</apiName>
         <cxxFunctionDetail>
             <cxxFunctionDefinition>
                 <cxxFunctionAccessSpecifier value="protected"/>
@@ -788,7 +788,7 @@ button-&gt;setShortcut&lt;/@func&gt;(tr(&quot;Alt+F7&quot;));</codeblock>
         </cxxFunctionDetail>
     </cxxFunction>
     <cxxFunction id="id-ad73478e-cd49-44d6-b341-cff959b114a9">
-        <apiName>hitButton</apiName>
+        <apiName  class="protected-functions">hitButton</apiName>
         <cxxFunctionDetail>
             <cxxFunctionDefinition>
                 <cxxFunctionAccessSpecifier value="protected"/>
@@ -958,7 +958,7 @@ button-&gt;setShortcut&lt;/@func&gt;(tr(&quot;Alt+F7&quot;));</codeblock>
         </cxxFunctionDetail>
     </cxxFunction>
     <cxxFunction id="id-4e4fac93-053e-44c8-88b3-be37f91a2a54">
-        <apiName>nextCheckState</apiName>
+        <apiName class="protected-functions">nextCheckState</apiName>
         <cxxFunctionDetail>
             <cxxFunctionDefinition>

As we fixed above issue similarly I would like to fix all following :

<p outputclass="protected-functions h2">Protected Functions</p>
<p outputclass="reimplemented-protected-functions h2">Reimplemented Protected Functions</p>

I can find some kind of references for classes for following in qabstractbutton.xml

<p outputclass="properties h2">Properties</p>
<p outputclass="public-functions h2">Public Functions</p>
<p outputclass="public-slots h2">Public Slots</p>
<p outputclass="signals h2">Signals</p>

If you look at : qvector.xml
reference for "Static Public Members" is missing there

It looks line it is necessary to go through all source and fine if reference is missing there then add it.

Also I found one more issue is that:
for e.g. qvector.xml
"Related Non-Members" (<p outputclass="related-non-members h2">Related Non-Members</p>)
does not contain any class body but it has :

 
<p outputclass="related-non-members h2">Related Non-Members</p>
<ul>
<li>QDataStream &amp; <xref href="qvector.xml#id-66bcb44a-fb7d-4c2c-8018-e29474ac5da6">operator&lt;&lt;</xref> ( QDataStream &amp; <i>out</i>, const QVector&lt;T&gt; &amp; <i>vector</i> )</li>
<li>QDataStream &amp; <xref href="qvector.xml#id-c6724e4e-309d-4aa3-b682-fbae43e4825e">operator&gt;&gt;</xref> ( QDataStream &amp; <i>in</i>, QVector&lt;T&gt; &amp; <i>vector</i> )</li>
</ul>

If we add "related-non-members" for <ul> = <ul class="related-non-members">

<p outputclass="related-non-members h2">Related Non-Members</p>
<ul class="related-non-members">
<li>QDataStream &amp; <xref href="qvector.xml#id-66bcb44a-fb7d-4c2c-8018-e29474ac5da6">operator&lt;&lt;</xref> ( QDataStream &amp; <i>out</i>, const QVector&lt;T&gt; &amp; <i>vector</i> )</li>
<li>QDataStream &amp; <xref href="qvector.xml#id-c6724e4e-309d-4aa3-b682-fbae43e4825e">operator&gt;&gt;</xref> ( QDataStream &amp; <i>in</i>, QVector&lt;T&gt; &amp; <i>vector</i> )</li>
</ul>

OR
some other way so we can differencieate above block with others and associeate it with related-non-members, for us it is necessary only for thise where there is no class definition.

Let me know if you need more information.

Attachments

- Sort By Name
- Sort By Date
- Ascending
- Descending
- Thumbnails
- List

doc_issue.png
302 kB
02 Dec '11 15:31

Gerrit Reviews

- Issue Only
- Show All Reviews
- Show Open Reviews
- Show All Issues
- Show Open Issues

No reviews matched the request. Check your Options in the drop-down menu of this sections header.

Activity

People

Assignee:: Martin Smith (Qt)

Reporter:: Gurudutt Verma

Votes:: 0 Vote for this issue

Watchers:: 1 Start watching this issue

Dates

Created:: 02 Dec '11 15:31

Updated:: 04 Sep '18 10:13

Resolved:: 12 Mar '12 09:38

Gerrit Reviews

There are no open Gerrit changes