[mapserver-dev] Motion: adopt MS RFC 132: Update MapScript API Docs

Seth G sethg at geographika.co.uk
Thu Jun 4 12:01:36 PDT 2020


Hi Steve,

I think it would be possible to do something similar with Doxygen as Even pointed out in the thread. 
However, I believe it would require i) downloading the full MapServer source to build the docs (rather than an additional Python requirement), an additional build step, and I'm not sure how SWIG only properties etc. would be filtered out. 
GDAL uses Doxygen for the C-API docs but not SWIG so further work/investigations would be needed. 

Also, I have an end-to-end working prototype for the SWIG/Python/Sphinx approach and several commits of docstrings ready to go..

If a C-API is to be documented in the future we could relook at merging the two approaches. 

Seth

--
web:http://geographika.co.uk
twitter: @geographika


On Wed, Jun 3, 2020, at 9:34 PM, Steve Lime wrote:
> There was a little discussion in another thread about using Doxygen - that's a dead end in terms of documenting MapScript? Otherwise a +1 from me. 
> 
> On Tue, Jun 2, 2020 at 4:05 PM Seth G <sethg at geographika.co.uk> wrote:
>> Hi all,
>> 
>>  Following on from the mail at https://lists.osgeo.org/pipermail/mapserver-dev/2020-May/016198.html I'd like to submit the motion: approve https://mapserver.org/development/rfc/ms-rfc-132.html
>> 
>>  Starting with my +1,
>> 
>>  Seth
>> 
>>  --
>>  web:http://geographika.co.uk
>>  twitter: @geographika
>>  _______________________________________________
>>  mapserver-dev mailing list
>> mapserver-dev at lists.osgeo.org
>> https://lists.osgeo.org/mailman/listinfo/mapserver-dev
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.osgeo.org/pipermail/mapserver-dev/attachments/20200604/aa4e019e/attachment.html>


More information about the mapserver-dev mailing list