<!DOCTYPE html><html><head><title></title><style type="text/css">p.MsoNormal,p.MsoNoSpacing{margin:0}</style></head><body><div>Thanks for the feedback Steve.<br></div><div><br></div><div>How about the grouping in <a href="https://github.com/mapserver/mapserver/pull/6071/commits/bdf511a52b834715fc32c77e00173b842ca72b64">https://github.com/mapserver/mapserver/pull/6071/commits/bdf511a52b834715fc32c77e00173b842ca72b64</a> ?<br></div><div><br></div><div><span class="blob-code-inner blob-code-marker">%immutable;</span><br></div><div><span class="blob-code-inner blob-code-marker">%<span class="pl-k">mutable</span>;</span><br></div><div><span class="blob-code-inner blob-code-marker">non SWIG</span><br></div><div><br></div><div><span class="blob-code-inner blob-code-marker">I'll move the <span class="pl-k">char</span> *<span class="pl-k">template</span>; to the immutable section. </span><br></div><div><br></div><div>SWIG is used to document all struct properties plus their types, and Sphinx then makes them linkable. <br></div><div><br></div><div><span class="blob-code-inner blob-code-marker">Seth<br></span></div><div><br></div><div id="sig62266145"><div>--<br></div><div>web:http://geographika.co.uk<br></div><div>twitter: @geographika<br></div></div><div><br></div><div><br></div><div>On Wed, May 20, 2020, at 12:53 AM, Steve Lime wrote:<br></div><blockquote type="cite" id="qt" style=""><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. <br></div></div><div dir="auto"><br></div><div dir="auto">—Steve<br></div><div><div><br></div><div class="qt-gmail_quote"><div dir="ltr" class="qt-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="qt-gmail_quote" style="margin-top:0px;margin-right:0px;margin-bottom:0px;margin-left:0.8ex;border-left-color:rgb(204, 204, 204);border-left-style:solid;border-left-width:1px;padding-left:1ex;"><div>Hi all,<br></div><div> <br></div><div> 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></div><div> <br></div><div> When adding the docstrings it would seem to make sense to regroup the struct properties. <br></div><div> I'm unsure if there is currently a logical grouping or ordering, or if properties have been organically added over the years. <br></div><div> <br></div><div> It would make sense while adding docstrings to reduce the number of SWIG guards, and regroup similar to below:<br></div><div> <br></div><div> struct classObj {<br></div><div> <br></div><div> #ifdef SWIG<br></div><div> %immutable;<br></div><div> #endif<br></div><div> <br></div><div> ..all SWIG immutable properties<br></div><div> #ifdef SWIG<br></div><div> %mutable;<br></div><div> #endif<br></div><div> <br></div><div> .. all SWIG mutable properties<br></div><div> <br></div><div> #ifndef SWIG<br></div><div> all non-SWIG properties<br></div><div> #endif /* not SWIG */<br></div><div> <br></div><div> };<br></div><div> <br></div><div> Does anyone see any issues with this, or reservations in general to adding the docstrings?<br></div><div> 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></div><div> <br></div><div> Regards,<br></div><div> <br></div><div> Seth<br></div><div> <br></div><div> --<br></div><div> web:<a href="http://geographika.co.uk" rel="noreferrer" target="_blank">http://geographika.co.uk</a><br></div><div> twitter: @geographika<br></div><div> _______________________________________________<br></div><div> mapserver-dev mailing list<br></div><div> <a href="mailto:mapserver-dev@lists.osgeo.org" target="_blank">mapserver-dev@lists.osgeo.org</a><br></div><div> <a href="https://lists.osgeo.org/mailman/listinfo/mapserver-dev" rel="noreferrer" target="_blank">https://lists.osgeo.org/mailman/listinfo/mapserver-dev</a><br></div></blockquote></div></div></blockquote><div><br></div></body></html>