From d5d4895c1e76f947a43b8d729455a63e7c165b28 Mon Sep 17 00:00:00 2001
From: Friedemann Kleint <Friedemann.Kleint@qt.io>
Date: Thu, 22 Apr 2021 15:14:36 +0200
Subject: Add documentation for the numpy overloads of functions taking point
 lists

Amends  6389561fd75e80c69d7c83f6a87d988450a2e569.

Task-number: PYSIDE-1540
Task-number: PYSIDE-1503
Change-Id: I0f424dccf4151d53d64f3aef923a32d3c3bf2641
Reviewed-by: Cristian Maureira-Fredes <cristian.maureira-fredes@qt.io>
---
 sources/pyside6/PySide6/QtCharts/typesystem_charts.xml  | 12 ++++++++++--
 sources/pyside6/PySide6/QtGui/typesystem_gui_common.xml |  6 +++++-
 2 files changed, 15 insertions(+), 3 deletions(-)

diff --git a/sources/pyside6/PySide6/QtCharts/typesystem_charts.xml b/sources/pyside6/PySide6/QtCharts/typesystem_charts.xml
index 6a325431b..eaeb78e61 100644
--- a/sources/pyside6/PySide6/QtCharts/typesystem_charts.xml
+++ b/sources/pyside6/PySide6/QtCharts/typesystem_charts.xml
@@ -271,11 +271,19 @@
        FIXME Subscripted generics cannot be used with class and instance checks -->
   <object-type name="QXYSeries">
       <include file-name="pyside_numpy.h" location="global"/>
-      <add-function signature="appendNp(PyArrayObject *, PyArrayObject *)">
+      <add-function signature="appendNp(PyArrayObject *@x@, PyArrayObject *@y@)">
           <inject-code file="../glue/qtcharts.cpp" snippet="qxyseries-appendnp-numpy-x-y"/>
+          <inject-documentation format="target" mode="append">
+          Adds the list of data points specified by two
+          one-dimensional, equally sized numpy arrays representing the x, y values, respectively.
+          </inject-documentation>
       </add-function>
-      <add-function signature="replaceNp(PyArrayObject *, PyArrayObject *)">
+      <add-function signature="replaceNp(PyArrayObject *@x@, PyArrayObject *@y@)">
           <inject-code file="../glue/qtcharts.cpp" snippet="qxyseries-replacenp-numpy-x-y"/>
+          <inject-documentation format="target" mode="append">
+          Replaces the current points with the points specified by two
+          one-dimensional, equally sized numpy arrays representing the x, y values, respectively.
+          </inject-documentation>
       </add-function>
   </object-type>
 </typesystem>
diff --git a/sources/pyside6/PySide6/QtGui/typesystem_gui_common.xml b/sources/pyside6/PySide6/QtGui/typesystem_gui_common.xml
index 4a230d5df..117476f23 100644
--- a/sources/pyside6/PySide6/QtGui/typesystem_gui_common.xml
+++ b/sources/pyside6/PySide6/QtGui/typesystem_gui_common.xml
@@ -1798,8 +1798,12 @@
     <!-- Add numpy versions as separate functions since passing ndarrays to other
          typecheck macros causes:
          FIXME Subscripted generics cannot be used with class and instance checks -->
-    <add-function signature="drawPointsNp(PyArrayObject *, PyArrayObject *)">
+    <add-function signature="drawPointsNp(PyArrayObject *@x@, PyArrayObject *@y@)">
         <inject-code file="../glue/qtgui.cpp" snippet="qpainter-drawpointsnp-numpy-x-y"/>
+        <inject-documentation format="target" mode="append">
+        Draws the points specified by two one-dimensional, equally sized numpy arrays
+        representing the x, y values, respectively.
+        </inject-documentation>
     </add-function>
 
     <modify-function signature="drawPolygon(const QPoint*,int,Qt::FillRule)" remove="all"/>
-- 
cgit v1.2.3