Skip to content

Commit

Permalink
Merge pull request OSGeo#9229 from dbaston/python-api-docs
Browse files Browse the repository at this point in the history
Doc: Add Python API docs for gdal.Dataset, gdal.Band
  • Loading branch information
rouault committed Feb 19, 2024
2 parents afda1a8 + d0231db commit e7f14b7
Show file tree
Hide file tree
Showing 8 changed files with 1,831 additions and 34 deletions.
1 change: 1 addition & 0 deletions doc/source/api/python/osgeo.gdal.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,4 @@ osgeo.gdal module
:members:
:undoc-members:
:show-inheritance:
:exclude-members: thisown
2 changes: 1 addition & 1 deletion gcore/gdaldataset.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -1094,7 +1094,7 @@ int CPL_STDCALL GDALGetRasterCount(GDALDatasetH hDS)
* When a projection definition is not available an empty (but not NULL)
* string is returned.
*
* \note Startig with GDAL 3.0, this is a compatibility layer around
* \note Starting with GDAL 3.0, this is a compatibility layer around
* GetSpatialRef()
*
* @return a pointer to an internal projection reference string. It should
Expand Down
4 changes: 2 additions & 2 deletions gcore/gdalrasterband.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -796,15 +796,15 @@ CPLErr CPL_STDCALL GDALWriteBlock(GDALRasterBandH hBand, int nXOff, int nYOff,
* block and so forth.
*
* @param nYBlockOff the vertical block offset, with zero indicating
* the left most block, 1 the next block and so forth.
* the top most block, 1 the next block and so forth.
*
* @param pnXValid pointer to an integer in which the number of valid pixels in
* the x direction will be stored
*
* @param pnYValid pointer to an integer in which the number of valid pixels in
* the y direction will be stored
*
* @return CE_None if the input parameter are valid, CE_Failure otherwise
* @return CE_None if the input parameters are valid, CE_Failure otherwise
*
* @since GDAL 2.2
*/
Expand Down
4 changes: 3 additions & 1 deletion gcore/overview.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -5636,7 +5636,9 @@ CPLErr GDALRegenerateOverviewsMultiBand(

/** Undocumented
* @param hSrcBand undocumented.
* @param nSampleStep undocumented.
* @param nSampleStep Step between scanlines used to compute statistics.
* When nSampleStep is equal to 1, all scanlines will
* be processed.
* @param pdfMean undocumented.
* @param pdfStdDev undocumented.
* @param pfnProgress undocumented.
Expand Down
Loading

0 comments on commit e7f14b7

Please sign in to comment.