Fix documentation for ninecell filters

qgis · Aug 8, 2018 · e79f6d1 · e79f6d1
1 parent 14f8c43
commit e79f6d1
Show file tree

Hide file tree

Showing 2 changed files with 23 additions and 2 deletions.
diff --git a/python/analysis/auto_generated/raster/qgsninecellfilter.sip.in b/python/analysis/auto_generated/raster/qgsninecellfilter.sip.in
@@ -36,6 +36,7 @@ Starts the calculation, reads from mInputFile and stores the result in mOutputFi
 :param feedback: feedback object that receives update and that is checked for cancelation.
 
 :return: 0 in case of success
+<<<<<<< 14f8c4361dc1f4103bed735a5cf46b38dcfa4a03
 <<<<<<< 528302cc8952497513b44423dfca6fcf4857760c
 <<<<<<< d6e747ca57807318c0b3f6be8266f0b43c0f7747
          TODO: return an enum
@@ -45,6 +46,8 @@ TODO: return an enum
 =======
          TODO: return an enum
 >>>>>>> Bindings for 9cell filter
+=======
+>>>>>>> Fix documentation for ninecell filters
 %End
 
     double cellSizeX() const;
@@ -64,8 +67,22 @@ TODO: return an enum
                                          float *x12, float *x22, float *x32,
                                          float *x13, float *x23, float *x33 ) = 0;
 %Docstring
-Calculates output value from nine input values. The input values and the output value can be equal to the
-nodata value if not present or outside of the border. Must be implemented by subclasses*
+Calculates output value from nine input values. The input values and the output
+value can be equal to the nodata value if not present or outside of the border.
+Must be implemented by subclasses.
+
+First index of the input cell is the row, second index is the column
+
+@param x11 surrounding cell top left
+@param x21 surrounding cell central left
+@param x31 surrounding cell bottom left
+@param x12 surrounding cell top central
+@param x22 the central cell for which the value will be calculated
+@param x32 surrounding cell bottom central
+@param x13 surrounding cell top right
+@param x23 surrounding cell central right
+@param x33 surrounding cell bottom right
+@return the calculated cell value for the central cell x22
 %End
 
   protected:

diff --git a/src/analysis/raster/qgsninecellfilter.cpp b/src/analysis/raster/qgsninecellfilter.cpp
@@ -507,6 +507,10 @@ int QgsNineCellFilter::processRasterGPU( const QString &source, QgsFeedback *fee
 =======
 >>>>>>> [opencl] Fix small OpenCL alg issues
 
+<<<<<<< 14f8c4361dc1f4103bed735a5cf46b38dcfa4a03
+=======
+
+>>>>>>> Fix documentation for ninecell filters
 // TODO: return an anum instead of an int
 int QgsNineCellFilter::processRasterCPU( QgsFeedback *feedback )
 {