gdal icon indicating copy to clipboard operation
gdal copied to clipboard

Improve / write docs

Open jdroenner opened this issue 4 years ago • 3 comments

The state of the documentation in this crate is not as it should be. This is a task is also ideal for new contributors. Most of the time the docs of the wrapped gdal-sys method will be enough to derive a methods doc.

jdroenner avatar Jan 05 '21 08:01 jdroenner

@jdroenner By this:

Most of the time the docs of the wrapped gdal-sys method will be enough to derive a methods doc.

are you suggesting (as a contribution) the gdal doxygen docs be copied over into the rust code?

metasim avatar Apr 18 '22 20:04 metasim

I just rebuilt the documentation with bindgen version 0.59.2, and it seems a lot more documentation is getting injected than what's in docs.rs:

image image

metasim avatar Apr 18 '22 22:04 metasim

I remember a bindgen "feature" causing comments to be included or not in the generated bindings based on the location of the GDAL headers.

lnicola avatar Apr 19 '22 14:04 lnicola