[mapguide][MG218][New] Updated comments in header files.

[Philip Sharman]

You can view the artifact detail at the following URL:

    https://mapguide.osgeo.org/servlets/Scarab/id/MG218

Type
 Defect

Artifact ID
 MG218 (Updated comments in header files.)

Reported by
 Philip Sharman
 philipsharman (philip.sharman at autodesk.com)

New artifact details:
---------------------------------------------------------

- Resolution set to new value
  Submitted
- Defect Severity set to new value
  Low
- Documentation Notes set to new value
  - Removed information about future plans from MgUserInformation
	C:\OSGeo+Perforce\mapguide\MgDev\Common\Service\System\UserInformation.h
	
- Marked some methods as internal.
	C:\OSGeo+Perforce\mapguide\MgDev\Common\Service\Services\BaseServiceDefs.h

- Moved this to the exceptions module:
	C:\OSGeo+Perforce\mapguide\MgDev\Common\Service\Exception\InvalidOperationVersionException.h

- This was marked NOT_EXPOSED_module, but it should be public.
	C:\OSGeo+Perforce\mapguide\MgDev\Common\Service\Services\ImageFormats.h
	
- This was marked NOT_EXPOSED_module, but it should be public. 
	C:\OSGeo+Perforce\mapguide\MgDev\Common\Service\Services\RasterTypes.h
	
- This was marked NOT_EXPOSED_module, but it should be public. 
	C:\OSGeo+Perforce\mapguide\MgDev\Common\Service\Services\UnitType.h
	
- Fixed incorrect parameter name in comments for GetWfsFeature
	C:\OSGeo+Perforce\mapguide\MgDev\Common\Service\Services\FeatureService.h

- Fixed incorrect parameter name in comments for QueryFeatures
	C:\OSGeo+Perforce\mapguide\MgDev\Common\Service\Services\RenderingService.h
		
- Fixed an incorrect <c> tag in the comments of SetResource
	C:\OSGeo+Perforce\mapguide\MgDev\Common\Service\Services\ResourceService.h

- Corrected \site to \link in EnumerateGroups
	C:\OSGeo+Perforce\mapguide\MgDev\Common\Service\Services\Site.h

- Added description for top, left, right, and bottom parameters of MgPlotSpecification
	C:\OSGeo+Perforce\mapguide\MgDev\Common\Service\Services\PlotSpecification.h

- Added \brief tag to 
	C:\OSGeo+Perforce\mapguide\MgDev\Common\Service\Net\AceStreamHelper.h

- Fixed bug 707203; clarified that the class name in MgSelection::Contains() is not optional.
	C:\OSGeo+Perforce\mapguide\MgDev\Common\Service\MapLayer\Selection.h

- Added \brief and \remarks etc in various places
	C:\OSGeo+Perforce\mapguide\MgDev\Common\Service\Services\FeatureInformation.h
	C:\OSGeo+Perforce\mapguide\MgDev\Common\Service\Geometry\Region.h

- Added a summary comment to
	C:\OSGeo+Perforce\mapguide\MgDev\Common\Service\Exception\LengthException.h

- Marked MgPageSizeUnits internal.
	C:\OSGeo+Perforce\mapguide\MgDev\Common\Service\Controller\DwfController.h

- Marked MgMappingServiceOpId as internal
	C:\OSGeo+Perforce\mapguide\MgDev\Common\Service\Services\MappingDefs.h
	

- Description set to new value
  Made various fixes to the comments.

This only affects the Web API Reference documentation.

Checked that WebTier.sln still builds correctly.
- Platform set to new value
  All
- Target milestone set to new value
  1.0.1
- Artifact Status set to new value
  New
- Version set to new value
  1.0.0
- Artifact created
- Resolution Description set to new value
  Fixed.
- Steps to Reproduce set to new value
  Build the Web API Reference.
- Subcomponent set to new value
  Web API
- Component set to new value
  Web Server Extensions
- Summary set to new value
  Updated comments in header files.
- Submission Reviewed set to new value
  No
- Operating system set to new value
  All
- Priority set to new value
  P5

---------------------------------------------------------
This message was automatically generated by Project Tracker.