[mapserver-dev] mapserver.h and SWIG

[Even Rouault]

On mercredi 20 mai 2020 00:09:26 CEST Seth G wrote:
> Hi all,
> 
> I've opened a new pull request at
> https://github.com/mapserver/mapserver/pull/6071 which adds docstrings for
> the classObj properties available in MapScript. These can then be used to
> generate automated API docs for MapScript using Sphinx.
> 
> When adding the docstrings it would seem to make sense to regroup the struct
> properties. I'm unsure if there is currently a logical grouping or
> ordering, or if properties have been organically added over the years.
> 
> It would make sense while adding docstrings to reduce the number of SWIG
> guards, and regroup similar to below:
> 
>   struct classObj {
> 
> #ifdef SWIG
>     %immutable;
> #endif
> 
> ..all SWIG immutable properties
> #ifdef SWIG
>     %mutable;
> #endif
> 
> .. all SWIG mutable properties
> 
> #ifndef SWIG
>     all non-SWIG properties
> #endif /* not SWIG */
> 
> };
> 
> Does anyone see any issues with this, or reservations in general to adding
> the docstrings? I've read through
> https://stackoverflow.com/questions/26818011/does-the-order-of-members-in-a
> -struct-matter but there are no array properties (at least for classObj).

Such reordering shouldn't be backported to a stable release, because this would affect the 
ABI.
Changing order in master should lead to a bump of the SONAME at the next release (for 
anything considered part of the API)


-- 
Spatialys - Geospatial professional services
http://www.spatialys.com
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/mapserver-dev/attachments/20200524/54207358/attachment.html>