Changes between Initial Version and Version 1 of Ticket #2097


Ignore:
Timestamp:
08/27/12 06:22:22 (12 years ago)
Author:
jng
Comment:

Legend:

Unmodified
Added
Removed
Modified

  • Ticket #2097

    • Property Summary Web API documentation missing tree and TOC → API documentation cleanup

  • Ticket #2097 – Description

    initial v1  
    1 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:
     1The current Web API documentation source does not cleanly build with  the version of doxygen that we're using (1.8.0).
     2
     3In addition, the documentation itself is missing in some parts
     4
     5 * Documentation of the WebApp classes (that are wrapped by the proxy classes in the the OSGeo.MapGuide.Web.dll assembly)
     6 * 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.
     7
     8~~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:
    29
    310 * The lack of a navigation tree
    411 * The lack of a TOC
    512
    6 The build process already warns about such issues, so something is definitely amiss here.
     13The build process already warns about such issues, so something is definitely amiss here.~~