<div><div dir="auto">Organic is a good word for it although there was some effort to group related properties so numlabels, labels and maxlabels were are next to one another. So this will scatter those a bit. Probably ok IMHO given the advantage keeping some docs close to the base structures. </div></div><div dir="auto"><br></div><div dir="auto">—Steve</div><div><br><div class="gmail_quote"><div dir="ltr" class="gmail_attr">On Tue, May 19, 2020 at 5:19 PM Seth G <<a href="mailto:sethg@geographika.co.uk">sethg@geographika.co.uk</a>> wrote:<br></div><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">Hi all,<br>
<br>
I've opened a new pull request at <a href="https://github.com/mapserver/mapserver/pull/6071" rel="noreferrer" target="_blank">https://github.com/mapserver/mapserver/pull/6071</a> which adds docstrings for the classObj properties available in MapScript. These can then be used to generate automated API docs for MapScript using Sphinx. <br>
<br>
When adding the docstrings it would seem to make sense to regroup the struct properties. <br>
I'm unsure if there is currently a logical grouping or ordering, or if properties have been organically added over the years. <br>
<br>
It would make sense while adding docstrings to reduce the number of SWIG guards, and regroup similar to below:<br>
<br>
  struct classObj {<br>
<br>
#ifdef SWIG<br>
    %immutable;<br>
#endif<br>
<br>
..all SWIG immutable properties<br>
#ifdef SWIG<br>
    %mutable;<br>
#endif<br>
<br>
.. all SWIG mutable properties<br>
<br>
#ifndef SWIG<br>
    all non-SWIG properties<br>
#endif /* not SWIG */<br>
<br>
};<br>
<br>
Does anyone see any issues with this, or reservations in general to adding the docstrings?<br>
I've read through <a href="https://stackoverflow.com/questions/26818011/does-the-order-of-members-in-a-struct-matter" rel="noreferrer" target="_blank">https://stackoverflow.com/questions/26818011/does-the-order-of-members-in-a-struct-matter</a> but there are no array properties (at least for classObj).<br>
<br>
Regards,<br>
<br>
Seth<br>
<br>
--<br>
web:<a href="http://geographika.co.uk" rel="noreferrer" target="_blank">http://geographika.co.uk</a><br>
twitter: @geographika<br>
_______________________________________________<br>
mapserver-dev mailing list<br>
<a href="mailto:mapserver-dev@lists.osgeo.org" target="_blank">mapserver-dev@lists.osgeo.org</a><br>
<a href="https://lists.osgeo.org/mailman/listinfo/mapserver-dev" rel="noreferrer" target="_blank">https://lists.osgeo.org/mailman/listinfo/mapserver-dev</a></blockquote></div></div>