diff --git a/ogr/ogr_feature.h b/ogr/ogr_feature.h index 70e1b38c51b1..764700079ca4 100644 --- a/ogr/ogr_feature.h +++ b/ogr/ogr_feature.h @@ -196,7 +196,10 @@ class CPL_DLL OGRFieldDefn } /** - * @brief IsGenerated + * @brief Return whether the field is a generated field. + * + * At time of writing, only the GeoPackage and PG drivers fill that information. Consequently, + * only a returned value equal to TRUE can be fully trusted. * @return TRUE if the field is a generated field, FALSE otherwise. * @since GDAL 3.11 */ diff --git a/ogr/ogrfeature.cpp b/ogr/ogrfeature.cpp index 8f2d8015b4ae..170394a9a203 100644 --- a/ogr/ogrfeature.cpp +++ b/ogr/ogrfeature.cpp @@ -1597,6 +1597,9 @@ int OGRFeature::IsFieldSet(int iField) const /** * \brief Test if a field is a generated field. * + * At time of writing, only the GeoPackage and PG drivers fill that information. Consequently, + * only a returned value equal to TRUE can be fully trusted. + * * This method is the same as the C function OGR_F_IsFieldGenerated(). * * @param iField the field to test. @@ -1620,6 +1623,8 @@ bool OGRFeature::IsFieldGenerated(int iField) const /** * \brief Test if a field is a generated field. * + * At time of writing, only the GeoPackage driver fills that information. Consequently, + * only a returned value equal to TRUE can be fully trusted. * This function is the same as the C++ method OGRFeature::IsFieldGenerated(). * * @param hFeat handle to the feature on which the field is.