Missing elements in the SWIG interface documentation

[Umberto Nicoletti]

Tamas,
I'll help you with this. Just split the list of to-dos in two and I'll
take one half.
Since we are at it I was wondering whether the mapscript documentation
on the mapserver web site is automagically updated from mapscript.txt
in cvs.
It would also be nice to generate an html version of the
documentationto include in the official ms releases.

Umberto

On 8/27/06, Tamas Szekeres <szekerest at gmail.com> wrote:
> Developers,
>
> After comparing the SWIG interface and the corresponding documentation
> the following elements are missing and should be updated in the doc.
> I'm considering some of the interface elements are not to be exposed at all.
>
> 1. Missing interface elements
>
> 1.1 constants:
>
> int MAX_ERROR_LEN
> int MS_MAXCLASSES
> int MS_MAXSTYLES
> int MS_MAXLAYERS
> int MS_POSITIONS_LENGTH
> int MS_SHP_POINTZ
> int MS_SHP_ARCZ
> int MS_SHP_POLYGONZ
> int MS_SHP_MULTIPOINTZ
> int MS_GEOSERR
> int MS_RECTERR
> int MS_TIMEERR
> int MS_GMLERR
> int MS_SOSERR
> int MS_HASHSIZE
> int MAX_PARAMS
>
> 1.2 enums:
>
> Some of the constants are exposed as enumerations missing from the documentation
>
> 1.3 functions:
>
> public static void msConnPoolCloseUnreferenced();
> public static void msFreeImage(imageObj img);
> public static errorObj msGetErrorObj();
> public static string msGetErrorString(string delimiter);
> public static string msGetVersion();
> public static void msResetErrorList();
> mapscript.msSaveImage(mapObj, imageObj, String) : Int32
> mapscript.msSetup() : Int32
>
> 1.4 classes:
>
> DBFFieldType class
> DBFInfo class
> imageObj.getBytes()
> intarray.cast()
> intarray.frompointer(int*)
> intarray.getItem(int)
> intarray.setItem(int, int)
> labelCacheMemberObj.labelpath
> labelCacheObj.labels
> labelObj.autofollow
> labelObj.encoding
> layerObj.labelangleitemindex
> layerObj.labelitemindex
> layerObj.labelsizeitemindex
> layerObj.plugin_library
> layerObj.plugin_library_original
> layerObj.getProjection()
> layerObj.setProcessing(string)
> layerObj.whichShapes(rectObj)
> lineObj.point
> mapObj.layerorder
> mapObj.outputformatlist
> mapObj.saved_extent
> mapObj.getNumSymbols()
> markerCacheMemberObj class
> outputFormatObj.formatoptions
> outputFormatObj.inmapfile
> outputFormatObj.numformatoptions
> outputFormatObj.refcount
> OWSRequest.contenttype
> queryMapObj class
> rectObj.fit(int,int)
> shapefileObj.isopen
> shapefileObj.lastshape
> shapefileObj.source
> shapefileObj.status
> shapefileObj.statusbounds
> shapefileObj.addPoint(pointObj)
> shapefileObj.getExtent(int, rectObj)
> shapefileObj.getPoint(int, pointObj)
> shapefileObj.getTransformed(mapObj, int, shapeObj)
> shapeObj.geometry
> shapeObj.line
> shapeObj.clone()
> styleObj.angle
> styleObj.angleitem
> styleObj.antialias
> styleObj.maxcolor
> styleObj.maxvalue
> styleObj.maxwidth
> styleObj.mincolor
> styleObj.minwidth
> styleObj.rangeitem
> styleObj.rangeitemindex
> styleObj.sizeitem
> styleObj.width
> symbolObj.style
> symbolObj.setImagepath(string)
> symbolSetObj.imagecachesize
> symbolSetObj.symbol
> webObj.browseformat
> webObj.legendformat
>
> 2. TODOs
>
> classObj.keyimage
> imageObj.size
> labelCacheMemberObj.featuresize
> labelCacheMemberObj.styles
> labelCacheObj.cachesize
> labelCacheObj.markercachesize
> labelObj.angle
> layerObj.footer
> layerObj.header
> layerObj.addFeature(shapeObj)
> layerObj.draw(mapObj, imageObj)
> layerObj.getNumFeatures
> mapObj.datapattern
> mapObj.maxsize
> mapObj.querymap
> mapObj.templatepattern
> mapObj.prepareQuery()
> OWSRequest.postrequest
> shapeObj.setBounds
> symbolObj.gap
> symbolObj.linecap
> symbolObj.linejoin
> symbolObj.linejoinmaxsize
> symbolObj.position
> symbolObj.sizex
> symbolObj.sizey
> symbolObj.transparent
> symbolObj.transparentcolor
> webObj.empty
> webObj.error
> webObj.log
> webObj.maxtemplate
> webObj.mintemplate
> webObj.queryformat
>
>
> Let us decide what to do with these elements. I think can document
> some of them but other volunteers should also be needed.
> \mapscript\doc\mapscript.txt should always be the most recent version.
> The class members should be placed into the documentation in alphabetical order.
>
>
> Tamas
>