Skip to content

Commit 926d626

Browse files
committed
Doc: fix warnings
1 parent b7f8808 commit 926d626

File tree

4 files changed

+28
-6
lines changed

4 files changed

+28
-6
lines changed

doc/source/api/gdalrasterband_cpp.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,21 @@ GDALRasterBand related functions
3434
.. doxygenfunction:: gdal::mean
3535
:project: api
3636

37+
.. doxygenfunction:: gdal::abs
38+
:project: api
39+
40+
.. doxygenfunction:: gdal::sqrt
41+
:project: api
42+
43+
.. doxygenfunction:: gdal::pow
44+
:project: api
45+
46+
.. doxygenfunction:: gdal::log
47+
:project: api
48+
49+
.. doxygenfunction:: gdal::log10
50+
:project: api
51+
3752
.. doxygenfunction:: gdal::IfThenElse
3853
:project: api
3954

doc/source/user/band_algebra.rst

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,15 +16,15 @@ from C++ and Python:
1616
- subtraction, with ``*`` operator
1717
- multiplication, with ``-`` operator
1818
- division, with ``/`` operator
19-
- absolute value / module, with :cpp:func:`gdal::abs` in C++ an
19+
- absolute value / module, with :cpp:func:`gdal::abs` in C++ and
2020
:py:meth:`osgeo.gdal.abs` in Python
21-
- square root, with :cpp:func:`gdal::sqrt` in C++ an
21+
- square root, with :cpp:func:`gdal::sqrt` in C++ and
2222
:py:meth:`osgeo.gdal.sqrt` in Python
23-
- logarithm base 10, with :cpp:func:`gdal::log10` in C++ an
23+
- logarithm base 10, with :cpp:func:`gdal::log10` in C++ and
2424
:py:meth:`osgeo.gdal.log10` in Python
25-
- natural logarithm, with :cpp:func:`gdal::log` in C++ an
25+
- natural logarithm, with :cpp:func:`gdal::log` in C++ and
2626
:py:meth:`osgeo.gdal.log` in Python
27-
- raising to the power, with :cpp:func:`gdal::pow` in C++ an
27+
- raising to the power, with :cpp:func:`gdal::pow` in C++ and
2828
:py:meth:`osgeo.gdal.pow` in Python
2929
- strictly greater than comparison, with ``>`` operator
3030
- greater or equal to comparison, with ``>=`` operator
@@ -51,7 +51,7 @@ Other operations are available:
5151
:py:meth:`osgeo.gdal.where` in Python (similar to `NumPy where <https://numpy.org/doc/stable/reference/generated/numpy.where.html>`__)
5252
- cast to a data type, with :cpp:func:`GDALRasterBand::AsType` in C++ and
5353
:py:meth:`osgeo.gdal.Band.astype` in Python
54-
- minimum of several bands (or constants), with :cpp:func:`gdal::min` in C++ an
54+
- minimum of several bands (or constants), with :cpp:func:`gdal::min` in C++ and
5555
:py:meth:`osgeo.gdal.minimum` in Python
5656
- maximum of several bands (or constants), with :cpp:func:`gdal::max` in C++ and
5757
:py:meth:`osgeo.gdal.maximum` in Python

gcore/gdal_priv.h

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2556,9 +2556,11 @@ GDALComputedRasterBand CPL_DLL log10(const GDALRasterBand &band);
25562556

25572557
using std::pow;
25582558
GDALComputedRasterBand CPL_DLL pow(const GDALRasterBand &band, double constant);
2559+
#ifndef DOXYGEN_SKIP
25592560
GDALComputedRasterBand CPL_DLL pow(double constant, const GDALRasterBand &band);
25602561
GDALComputedRasterBand CPL_DLL pow(const GDALRasterBand &band1,
25612562
const GDALRasterBand &band2);
2563+
#endif
25622564

25632565
GDALComputedRasterBand CPL_DLL IfThenElse(const GDALRasterBand &condBand,
25642566
const GDALRasterBand &thenBand,

gcore/gdalrasterband.cpp

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12067,6 +12067,7 @@ GDALComputedRasterBand log10(const GDALRasterBand &band)
1206712067
namespace gdal
1206812068
{
1206912069

12070+
#ifndef DOXYGEN_SKIP
1207012071
/** Return a band whose each pixel value is the constant raised to the power of
1207112072
* the corresponding pixel value in the input band.
1207212073
*
@@ -12080,6 +12081,8 @@ GDALComputedRasterBand pow(double constant, const GDALRasterBand &band)
1208012081
return GDALComputedRasterBand(GDALComputedRasterBand::Operation::OP_POW,
1208112082
constant, band);
1208212083
}
12084+
#endif
12085+
1208312086
} // namespace gdal
1208412087

1208512088
/************************************************************************/
@@ -12111,6 +12114,7 @@ GDALComputedRasterBand pow(const GDALRasterBand &band, double constant)
1211112114
namespace gdal
1211212115
{
1211312116

12117+
#ifndef DOXYGEN_SKIP
1211412118
/** Return a band whose each pixel value is the the corresponding pixel value
1211512119
* in the input band1 raised to the power of the corresponding pixel value
1211612120
* in the input band2
@@ -12134,4 +12138,5 @@ GDALComputedRasterBand pow(const GDALRasterBand &band1,
1213412138
band1, band2);
1213512139
#endif
1213612140
}
12141+
#endif
1213712142
} // namespace gdal

0 commit comments

Comments
 (0)