[Mapguide-trac] [mapguide-trac] #2097: API documentation cleanup

[MapGuide Open Source]

#2097: API documentation cleanup
-----------------------------+----------------------------------------------
   Reporter:  jng            |       Owner:  jng
       Type:  defect         |      Status:  new
   Priority:  low            |   Milestone:  2.4
  Component:  Documentation  |     Version:     
   Severity:  trivial        |    Keywords:     
External_id:                 |  
-----------------------------+----------------------------------------------
Description changed by jng:

Old description:

> The current Web API documentation source does not cleanly build with  the
> version of doxygen that we're using (1.8.0).
>
> In addition, the documentation itself is missing in some parts
>
>  * Documentation of the WebApp classes (that are wrapped by the proxy
> classes in the the OSGeo.MapGuide.Web.dll assembly)
>  * Some internal classes are being leaked out. Need to compare with the
> exposed classes of the .net assemblies to determine which classes need to
> be hidden.
>  * Lots of Ptr<T> forward declarations appearing under "variables"
>
> ~~If you look at the generated Web API documentation for 2.4 and compare
> it to the "published" 2.0 version on mapguide.osgeo.org you can see there
> are some stark differences:~~
>
>  * ~~The lack of a navigation tree~~
>  * ~~The lack of a TOC~~
>
> ~~The build process already warns about such issues, so something is
> definitely amiss here.~~

New description:

 The current Web API documentation source does not cleanly build with  the
 version of doxygen that we're using (1.8.0).

 In addition, the documentation itself is missing in some parts

  * Documentation of the WebApp classes (that are wrapped by the proxy
 classes in the the OSGeo.MapGuide.Web.dll assembly)
  * Some internal classes are being leaked out. Need to compare with the
 exposed classes of the .net assemblies to determine which classes need to
 be hidden.
  * Lots of Ptr<T> forward declarations appearing under "variables"
  * Methods and classes introduced through RFCs should be documented using
 the content of the submitted RFC where applicable.

 ~~If you look at the generated Web API documentation for 2.4 and compare
 it to the "published" 2.0 version on mapguide.osgeo.org you can see there
 are some stark differences:~~

  * ~~The lack of a navigation tree~~
  * ~~The lack of a TOC~~

 ~~The build process already warns about such issues, so something is
 definitely amiss here.~~

--

-- 
Ticket URL: <http://trac.osgeo.org/mapguide/ticket/2097#comment:6>
MapGuide Open Source <http://mapguide.osgeo.org/>
MapGuide Open Source Internals