[gdal-dev] Doxygen Arguments

[Daniel Baston]

It looks like Doxygen is using argument names from the function prototype
instead of the implementation:
https://github.com/OSGeo/gdal/blob/master/gcore/gdal_priv.h#L753

I did some searching but didn't come across a way to change this behavior.
It looks like many other functions include the argument names in the
prototype, so maybe RasterIO should be updated to include them too?

Dan

On Thu, May 9, 2024 at 9:20 AM Andrew Bell via gdal-dev <
gdal-dev at lists.osgeo.org> wrote:

> 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
>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/gdal-dev/attachments/20240509/33e05091/attachment.htm>