[Gdal-dev] Documentation Suggestions

[Andrew Bell]

Hi,

Here are a few suggestions for the OGR documentation:

====================

OGR_G_ExportToWkt()

ppszSrcText 	a text buffer is allocated by the program, and assigned
to the passed pointer.

* "allocated by the program" be better said as "allocated by OGR".
Some note should also say that the buffer should be deallocated with
free() or VSIFree().  (Is there a better way?)

==================

OGR_G_DestroyGeometry

*Some note should be made that a geometry in a feature will be
destroyed when the feature is destroyed and does not need to be
explicitly deallocated with this call.

=================

OGR_L_GetNextFeature

*The documentation says that it is the responsibility of the caller to
delete the object, but it doesn't say how.  Perhaps a reference to
OGR_F_Destroy is in order.  There are other calls that have this same
issue.

=================

OGR_F_Destroy

*The text here is confusing.  You can't free memory _onto_ anywhere,
you can only free memory that has been allocated where it was
allocated.  I'm not sure what this is trying to get across.

Cheers,

-- 
Andrew Bell
andrew.bell.ia at gmail.com