Opened 5 years ago

Closed 4 years ago

#2097 closed defect (fixed)

API documentation cleanup

Reported by: jng Owned by: jng
Priority: low Milestone:
Component: Documentation Version:
Severity: trivial Keywords:
Cc: External ID:

Description (last modified by jng)

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.

Change History (9)

comment:1 Changed 5 years ago by jng

Description: modified (diff)
Summary: Web API documentation missing tree and TOCAPI documentation cleanup

comment:2 Changed 5 years ago by jng

Description: modified (diff)

comment:3 Changed 5 years ago by jng

The following types should not be in the documentation (based on .net assembly class listing)

comment:5 Changed 5 years ago by jng

Description: modified (diff)

comment:6 Changed 5 years ago by jng

Description: modified (diff)

comment:7 Changed 5 years ago by jng

Milestone: 2.42.5

Freezing for 2.4

comment:8 Changed 5 years ago by jng

Milestone: 2.5

comment:9 Changed 4 years ago by jng

Resolution: fixed
Status: newclosed
Note: See TracTickets for help on using tickets.