Opened 14 years ago

Closed 13 years ago

#3440 closed defect (fixed)

missing return value for mapscript function whichShapes in documentation

Reported by: ochriste Owned by: jmckenna
Priority: normal Milestone:
Component: Documentation - MapServer Version: unspecified
Severity: trivial Keywords:
Cc: havatv

Description

The current mapscript documentation (swig or php) is incomplet regarding the possible values returned by the whichShapes function.

The function returns MS_SUCCESS, MS_FAILURE or MS_DONE, and not only MS_SUCCESS or MS_FAILURE.

see thread ​http://lists.osgeo.org/pipermail/mapserver-dev/2010-April/009921.html

I have attached a patch made againt Mapserver's trunk documentation

Attachments (1)

mapscript.txt.patch​ (849 bytes ) - added by ochriste 14 years ago.
patch with documentation complement for function whichShapes

Download all attachments as: .zip

Change History (2)

by ochriste, 14 years ago

Attachment: mapscript.txt.patch​ added

patch with documentation complement for function whichShapes

comment:1 by havatv, 13 years ago

Cc: havatv added
Resolution: → fixed
Status: new → closed

Fixed for 6.0 and trunk swig and php documentation in r12557. I could not verify the ignore missing data part, so I left that out. This is how it looks now for swig: 

  Returns MS_SUCCESS, MS_FAILURE or MS_DONE.  MS_DONE is returned if
  the layer extent does not overlap rect.
Note: See TracTickets for help on using tickets.