Add documentation #158
Merged
Add documentation #158
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
+ add docs for `Dataset` and `RasterBand`. + fix `cfg()` for GDAL OpenEx flags.
|
cool!more documentation is always good. I don't have an answer to the doxygen links. I guess we could link the doxygen startpage and leave the user to find the method? |
|
Broken links lead to the start page (via a 404) anyway; hopefully the text of the link tells the user what to search for. Let's take a call when any of these links break. |
2 tasks
|
Excellent - Thank you @rmanoka! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Added documentations for
DatasetandRasterBand, and fixedcfg()for some of theopen_exflags (it wasn't enabled on gdal 3.0 and above).Open question: how to refer to GDAL documentations from our docs? For many functions, the relevant docs are doxygen links (eg. GDALOpenEx) which could break if it is regenerated upstream (and annoying to update).
CHANGES.mdif knowledge of this change could be valuable to users.