Add comment

qgis · Feb 3, 2012 · 0ce442d · 0ce442d
1 parent 287cf8f
commit 0ce442d
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 0 deletions.
diff --git a/python/analysis/qgsgeometryanalyzer.sip b/python/analysis/qgsgeometryanalyzer.sip
@@ -51,8 +51,13 @@ class QgsGeometryAnalyzer
       @param eventLayer layer with features and location field
       @param lineField join index in line layer
       @param eventField join index in event layer
+      @param outputLayer name of output file (can be empty if a memory layer is used)
+      @param outputFormat name of output format (can be empty if a memory provider is used to store the results)
+      @param unlocatedFeatureIds out: ids of event features where linear referencing was not successful
       @param locationField1 attribute index of location field in event layer
       @param locationField2 attribute index of location end field (or -1 for point layer)
+      @param memoryProvider memory provider to write output to (can be 0 if output is written to a file)
+      @param p progress dialog or 0 if no progress dialog should be shown
     */
     bool eventLayer( QgsVectorLayer* lineLayer, QgsVectorLayer* eventLayer, int lineField, int eventField, QList<int>& unlocatedFeatureIds /Out/,
                      const QString& outputLayer, const QString& outputFormat, int locationField1, int locationField2 = -1, QgsVectorDataProvider* memoryProvider = 0, QProgressDialog* p = 0 );

diff --git a/src/analysis/vector/qgsgeometryanalyzer.h b/src/analysis/vector/qgsgeometryanalyzer.h
@@ -106,8 +106,13 @@ class ANALYSIS_EXPORT QgsGeometryAnalyzer
       @param eventLayer layer with features and location field
       @param lineField join index in line layer
       @param eventField join index in event layer
+      @param outputLayer name of output file (can be empty if a memory layer is used)
+      @param outputFormat name of output format (can be empty if a memory provider is used to store the results)
+      @param unlocatedFeatureIds out: ids of event features where linear referencing was not successful
       @param locationField1 attribute index of location field in event layer
       @param locationField2 attribute index of location end field (or -1 for point layer)
+      @param memoryProvider memory provider to write output to (can be 0 if output is written to a file)
+      @param p progress dialog or 0 if no progress dialog should be shown
     */
     bool eventLayer( QgsVectorLayer* lineLayer, QgsVectorLayer* eventLayer, int lineField, int eventField, QList<int>& unlocatedFeatureIds, const QString& outputLayer,
                      const QString& outputFormat, int locationField1, int locationField2 = -1, QgsVectorDataProvider* memoryProvider = 0, QProgressDialog* p = 0 );