[gdal-dev] Doxygen Arguments

Even Rouault even.rouault at spatialys.com
Thu May 9 09:11:57 PDT 2024


Andrew,

this is now fixed per 
https://github.com/OSGeo/gdal/commit/393eee77b40ae16751e4d2c0ad3e53386b22d025 
. Doxygen apparently takes the function/method at declaration time, and 
not definition time, and we had a number of unnamed parameters in 
declarations. (I also struggled with weird things when trying to fix 
that locally due not using a too recent Doxygen version. The HTML output 
was fine, but once integrated with Sphinx/Breathe, the parameters were 
still missing. Updating to Doxygen 1.9.8 as now used by our CI fixed things)

Even

Le 09/05/2024 à 15:20, Andrew Bell via gdal-dev a écrit :
> Hi,
>
> I'm looking at the documentation for GDALRasterBand::RasterIO and it's 
> surprising that the names of the arguments aren't included in the 
> function prototype despite them being in the doxygen function 
> definition. The arguments are described well below the function 
> prototype, making it hard to match things up and you have to assume 
> that the order matches.
>
> Does some doxygen expert know how the argument names could somehow be 
> included in the function prototype?
>
> Web page: 
> https://gdal.org/api/gdalrasterband_cpp.html#classGDALRasterBand_1a75d4af97b3436a4e79d9759eedf89af4
>
> Source: https://fossies.org/linux/gdal/gcore/gdalrasterband.cpp (line 110)
>
> --
> Andrew Bell
> andrew.bell.ia at gmail.com
>
> _______________________________________________
> gdal-dev mailing list
> gdal-dev at lists.osgeo.org
> https://lists.osgeo.org/mailman/listinfo/gdal-dev

-- 
http://www.spatialys.com
My software is free, but my time generally not.
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/gdal-dev/attachments/20240509/0a9fc600/attachment.htm>


More information about the gdal-dev mailing list