Add comments to some function removals.

1 files changed, 46 insertions, 35 deletions

diff --git a/PySide/QtCore/typesystem_core.xml b/PySide/QtCore/typesystem_core.xml
index 6a0d88282..92659d2b6 100644
--- a/PySide/QtCore/typesystem_core.xml
+++ b/PySide/QtCore/typesystem_core.xml
@@ -919,7 +919,7 @@
             Py_XINCREF(%PYARG_0);
         </inject-code>
     </modify-function>
-    <!-- FIXME Removed due to a shiboken bug-->
+    <!-- BUG 716 -->
     <modify-function signature="operator const QModelIndex&amp;()const" remove="all" />
   </value-type>
   <value-type name="QUuid">
@@ -941,8 +941,6 @@
             </insert-template>
         </inject-code>
     </add-function>
-    <!-- Removed because we already have the QString overload -->
-    <modify-function signature="QUuid(const char*)" remove="all" />
   </value-type>
 
   <value-type name="QLocale">
@@ -1565,13 +1563,14 @@
         #endif
     </inject-code>
 
-   <modify-function signature="data()const">
+   <modify-function signature="data()">
        <inject-code class="target" position="beginning">
            %PYARG_0 = PyString_FromStringAndSize(%CPPSELF.%FUNCTION_NAME(), %CPPSELF.size());
        </inject-code>
    </modify-function>
 
     <!-- removed functions -->
+    <!--### Functions removed because they return STL-like iterators -->
     <modify-function signature="begin()" remove="all"/>
     <modify-function signature="begin()const" remove="all"/>
     <modify-function signature="constBegin()const" remove="all"/>
@@ -1579,10 +1578,11 @@
     <modify-function signature="constEnd()const" remove="all"/>
     <modify-function signature="end()" remove="all"/>
     <modify-function signature="end()const" remove="all"/>
+    <!--### -->
+
+    <!--### Functions removed because they provide useless overloads from Python point of view -->
     <modify-function signature="number(uint,int)" remove="all"/>
     <modify-function signature="number(qulonglong,int)" remove="all"/>
-    <modify-function signature="operator const char *()const" remove="all"/>
-    <modify-function signature="operator const void *()const" remove="all"/>
     <modify-function signature="operator+=(const char*)" remove="all"/>
     <modify-function signature="operator==(const char*,QByteArray)" remove="all" />
     <modify-function signature="operator!=(const char*,QByteArray)" remove="all" />
@@ -1893,12 +1893,10 @@
     <extra-includes>
       <include file-name="QAbstractFileEngine" location="global"/>
     </extra-includes>
+    <!-- ### See bug 721 -->
     <modify-function signature="unmap(uchar*)" remove="all"/>
-    <!-- Can't provide same API and performance -->
-    <modify-function signature="open(int,QFlags&lt;QIODevice::OpenModeFlag&gt;)" remove="all"/>
-    <modify-function signature="decodeName(const char*)" remove="all"/>
     <modify-function signature="map(qint64,qint64,QFile::MemoryMapFlags)" remove="all"/>
-    <modify-function signature="unmap(uchar*)" remove="all"/>
+    <!-- ### -->
 
     <modify-function signature="remove()" allow-thread="yes"/>
     <modify-function signature="remove(const QString&amp;)" allow-thread="yes"/>
@@ -1920,9 +1918,13 @@
     <modify-function signature="write(const QByteArray&amp;)" allow-thread="yes"/>
     <modify-function signature="waitForReadyRead(int)" allow-thread="yes"/>
     <modify-function signature="waitForBytesWritten(int)" allow-thread="yes"/>
+    <!-- ### peek(qint64) do the job -->
     <modify-function signature="peek(char *,qint64)" remove="all"/>
+    <!-- ### read(qint64) do the job -->
     <modify-function signature="read(char *,qint64)" remove="all"/>
+    <!-- ### readLine(qint64) do the job -->
     <modify-function signature="readLine(char *,qint64)" remove="all"/>
+    <!-- ### write(str) do the job -->
     <modify-function signature="write(const char *,qint64)" remove="all"/>
     <modify-function signature="getChar(char *)">
         <modify-argument index="1">
@@ -2057,11 +2059,13 @@
     </modify-function>
   </object-type>
   <object-type name="QTextDecoder">
+    <!-- ### toUnicode(QByteArray) to the job -->
     <modify-function signature="toUnicode(const char*,int)" remove="all" />
-    <!-- Removed because it expect QString to be mutable -->
     <modify-function signature="toUnicode(QString*,const char*,int)" remove="all" />
+    <!-- ### -->
   </object-type>
   <object-type name="QTextEncoder">
+    <!-- fromUnicode(String) do the job -->
     <modify-function signature="fromUnicode(const QChar*,int)" remove="all" />
   </object-type>
   <object-type name="QTimeLine">
@@ -2100,10 +2104,8 @@
       <include file-name="QStringList" location="global"/>
     </extra-includes>
   </object-type>
-  <!-- FIXME Removed due to a shiboken bug-->
   <object-type name="QBuffer">
-    <modify-function signature="buffer()const" remove="all"/>
-    <modify-function signature="data()const" remove="all"/>
+    <!-- ### setData(QByteArray) do the job -->
     <modify-function signature="setData(const char*,int)" remove="all"/>
   </object-type>
   <object-type name="QTimer">
@@ -2181,7 +2183,7 @@
     <extra-includes>
       <include file-name="QDateTime" location="global"/>
     </extra-includes>
-    <modify-function signature="unmap(uchar*)" remove="all"/>
+
     <modify-function signature="open(QFlags&lt;QIODevice::OpenModeFlag>)" allow-thread="yes" />
     <modify-function signature="close()" allow-thread="yes" />
     <modify-function signature="flush()" allow-thread="yes" />
@@ -2193,8 +2195,13 @@
     <modify-function signature="mkdir(const QString&amp;, bool)const" allow-thread="yes" />
     <modify-function signature="rmdir(const QString&amp;, bool)const" allow-thread="yes" />
     <modify-function signature="write(const char*, qint64)" allow-thread="yes" />
+
+    <!-- ### See bug 724 -->
+    <modify-function signature="unmap(uchar*)" remove="all"/>
+    <!-- ### See bug 723 -->
     <modify-function signature="read(char*, qint64)" allow-thread="yes" remove="all" />
     <modify-function signature="readLine(char*, qint64)" allow-thread="yes" remove="all" />
+    <!-- ### -->
   </object-type>
   <object-type name="QProcess">
     <enum-type name="ExitStatus"/>
@@ -2202,7 +2209,7 @@
     <enum-type name="ProcessChannelMode"/>
     <enum-type name="ProcessError"/>
     <enum-type name="ProcessState"/>
-    <modify-function signature="readChannelMode()const" remove="all"/>
+
     <modify-function signature="waitForStarted(int)" allow-thread="yes"/>
     <modify-function signature="waitForBytesWritten(int)" allow-thread="yes"/>
     <modify-function signature="waitForFinished(int)" allow-thread="yes"/>
@@ -2210,8 +2217,6 @@
     <modify-function signature="readAllStandardError()" allow-thread="yes"/>
     <modify-function signature="execute(QString, QStringList)" allow-thread="yes"/>
     <modify-function signature="execute(QString)" allow-thread="yes"/>
-    <!--### Obsolete in 4.3-->
-    <modify-function signature="setReadChannelMode(QProcess::ProcessChannelMode)" remove="all"/>
     <modify-function signature="startDetached(QString,QStringList,QString,qint64*)">
         <modify-argument index="4">
             <remove-argument />
@@ -2225,6 +2230,10 @@
         %PYARG_0 = Shiboken::makeTuple(retval, pid);
         </inject-code>
     </modify-function>
+    <!--### Obsolete in 4.3-->
+    <modify-function signature="setReadChannelMode(QProcess::ProcessChannelMode)" remove="all"/>
+    <modify-function signature="readChannelMode()const" remove="all"/>
+    <!-- ### -->
   </object-type>
   <object-type name="QSignalMapper" />
 
@@ -2260,10 +2269,10 @@
     </modify-function>
 
     <modify-function signature="exec()" rename="exec_" allow-thread="yes"/>
-    <modify-function signature="argv()" remove="all"/>
-    <!-- Obsolete -->
+    <!-- ### Obsolete -->
     <modify-function signature="argc()" remove="all"/>
-    <!-- Obsolete -->
+    <modify-function signature="argv()" remove="all"/>
+    <!-- ### -->
     <modify-function signature="notify(QObject*,QEvent*)" allow-thread="yes">
       <modify-argument index="2" invalidate-after-use="yes"/>
     </modify-function>
@@ -2336,6 +2345,7 @@
       </modify-argument>
     </modify-function>
 
+    <!-- ### Replaced by write<TYPE> methods -->
     <modify-function signature="operator&gt;&gt;(qint8&amp;)" remove="all"/>
     <modify-function signature="operator&gt;&gt;(bool&amp;)" remove="all"/>
     <modify-function signature="operator&gt;&gt;(quint8&amp;)" remove="all"/>
@@ -2348,7 +2358,9 @@
     <modify-function signature="operator&gt;&gt;(float&amp;)" remove="all"/>
     <modify-function signature="operator&gt;&gt;(double&amp;)" remove="all"/>
     <modify-function signature="operator&gt;&gt;(char*&amp;)" remove="all"/>
+    <!-- ### -->
 
+    <!-- ### Replaced by read<TYPE> methods -->
     <modify-function signature="operator&lt;&lt;(qint8)" remove="all"/>
     <modify-function signature="operator&lt;&lt;(bool)" remove="all"/>
     <modify-function signature="operator&lt;&lt;(quint8)" remove="all"/>
@@ -2361,6 +2373,7 @@
     <modify-function signature="operator&lt;&lt;(float)" remove="all"/>
     <modify-function signature="operator&lt;&lt;(double)" remove="all"/>
     <modify-function signature="operator&lt;&lt;(const char*)" remove="all"/>
+    <!-- ### -->
     <add-function signature="writeQString(const QString&amp;)">
         <inject-code class="target">
             *(%CPPSELF) &lt;&lt; %1;
@@ -2426,8 +2439,6 @@
             }
         </inject-code>
     </modify-function>
-    <!-- deprecated method -->
-    <modify-function signature="readBytes(char*&amp;,uint&amp;)" remove="all"/>
     <modify-function signature="writeRawData(const char*,int)">
         <modify-argument index="2">
             <remove-argument />
@@ -2437,11 +2448,8 @@
             %PYARG_0 = %CONVERTTOPYTHON[int](r);
         </inject-code>
     </modify-function>
-    <!-- deprecated method -->
-    <modify-function signature="writeBytes(const char*,uint)" remove="all" />
 
     <!-- Extra functions for primitive type handling -->
-
     <add-function signature="readBool()" return-type="bool">
         <inject-code class="target" position="end">
             <insert-template name="stream_read_method"/>
@@ -2564,7 +2572,9 @@
         </inject-code>
     </add-function>
 
-
+    <!-- ### deprecated method -->
+    <modify-function signature="readBytes(char*&amp;,uint&amp;)" remove="all"/>
+    <modify-function signature="writeBytes(const char*,uint)" remove="all" />
   </object-type>
   <object-type name="QFSFileEngine">
     <extra-includes>
@@ -2632,10 +2642,6 @@
     <modify-function signature="pop_back()" remove="all"/>
     <modify-function signature="push_front(QXmlStreamAttribute)" remove="all"/>
     <modify-function signature="pop_front()" remove="all"/>
-    <modify-function signature="at(int) const" remove="all"/>
-    <modify-function signature="contains(const QXmlStreamAttribute &amp;)const" remove="all"/>
-    <modify-function signature="fill(QXmlStreamAttribute, int)" remove="all"/>
-    <modify-function signature="mid(int, int) const" remove="all"/>
     <modify-function signature="toList() const" remove="all"/>
     <modify-function signature="fromList(const QList&lt;QXmlStreamAttribute&gt; &amp;)" remove="all"/>
     <modify-function signature="operator+=(QVector)" remove="all" />
@@ -2647,8 +2653,6 @@
     <enum-type name="Error"/>
     <enum-type name="TokenType"/>
     <enum-type name="ReadElementTextBehaviour"/>
-    <modify-function signature="QXmlStreamReader(const char*)" remove="all"/>
-    <modify-function signature="addData(const char*)" remove="all"/>
   </object-type>
   <object-type name="QXmlStreamWriter">
     <!-- Removed because it expect QString to be mutable -->
@@ -2692,15 +2696,19 @@
   <object-type name="QMetaObject">
     <enum-type name="Call"/>
     <include file-name="qobjectdefs.h" location="global" />
+    <!-- This isn't part of Qt public API -->
     <modify-function signature="connect(const QObject*, int, const QObject*, int, int, int*)" remove="all" />
   </object-type>
   <value-type name="QMetaProperty" >
+    <!-- This isn't part of Qt public API -->
     <modify-function signature="enclosingMetaObject()const" remove="all" />
   </value-type>
   <value-type name="QMetaClassInfo">
+    <!-- This isn't part of Qt public API -->
     <modify-function signature="enclosingMetaObject()const" remove="all" />
   </value-type>
   <value-type name="QMetaEnum">
+    <!-- This isn't part of Qt public API -->
     <modify-function signature="enclosingMetaObject()const" remove="all" />
   </value-type>
   <!-- From Qt4.6 -->
@@ -2798,7 +2806,10 @@
 
   <!-- FIXME: setCustomType() actually takes a pointer to function type
   (EasingFunction), but for some reason apiextractor thinks it is a float/double:
-  http://bugs.openbossa.org/show_bug.cgi?id=201 -->
+  http://bugs.pyside.org/show_bug.cgi?id=201
+  Se also bug:
+  http://bugs.pyside.org/show_bug.cgi?id=725
+  -->
   <rejection class="QEasingCurve" function-name="setCustomType"/>
   <value-type name="QEasingCurve">
     <enum-type name="Type"/>
@@ -2943,7 +2954,7 @@
         </inject-code>
     </add-function>
 
-   <!-- Replaced by a added function -->
+    <!-- Replaced by a added function -->
     <modify-function signature="defaultAnimations() const" remove="all"/>
     <add-function signature="defaultAnimations()" return-type="list of QAbstractAnimation" >
         <inject-code class="target" position="beginning">