[mapguide-commits] r6961 - in branches/2.4/MgDev/Doc: . group_and_page_definitions headers_and_footers
svn_mapguide at osgeo.org
svn_mapguide at osgeo.org
Wed Aug 29 11:16:57 PDT 2012
Author: jng
Date: 2012-08-29 11:16:56 -0700 (Wed, 29 Aug 2012)
New Revision: 6961
Modified:
branches/2.4/MgDev/Doc/MgOpenSource_Doxyfile
branches/2.4/MgDev/Doc/group_and_page_definitions/define_groups.h
branches/2.4/MgDev/Doc/group_and_page_definitions/define_pages.h
branches/2.4/MgDev/Doc/headers_and_footers/header.html
Log:
#2097: Make parts of the API reference content conditional. This allows us to have a common base API reference with conditional bits of content for MapGuide and mg-desktop (in the future). Re-usable documentation ftw!
Modified: branches/2.4/MgDev/Doc/MgOpenSource_Doxyfile
===================================================================
--- branches/2.4/MgDev/Doc/MgOpenSource_Doxyfile 2012-08-29 16:24:48 UTC (rev 6960)
+++ branches/2.4/MgDev/Doc/MgOpenSource_Doxyfile 2012-08-29 18:16:56 UTC (rev 6961)
@@ -78,7 +78,8 @@
GENERATE_TESTLIST = NO
GENERATE_BUGLIST = NO
GENERATE_DEPRECATEDLIST= YES
-ENABLED_SECTIONS =
+#This is to toggle MapGuide API-specific content
+ENABLED_SECTIONS = MAPGUIDEAPI
MAX_INITIALIZER_LINES = 30
SHOW_USED_FILES = NO
SHOW_DIRECTORIES = NO
@@ -96,7 +97,7 @@
WARN_IF_DOC_ERROR = YES
WARN_NO_PARAMDOC = YES
WARN_FORMAT = "$file:$line: $text"
-WARN_LOGFILE = MgOpenSource_warn_log.txt
+WARN_LOGFILE = MgOpensource_warn_log.txt
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
Modified: branches/2.4/MgDev/Doc/group_and_page_definitions/define_groups.h
===================================================================
--- branches/2.4/MgDev/Doc/group_and_page_definitions/define_groups.h 2012-08-29 16:24:48 UTC (rev 6960)
+++ branches/2.4/MgDev/Doc/group_and_page_definitions/define_groups.h 2012-08-29 18:16:56 UTC (rev 6961)
@@ -1,24 +1,31 @@
/**
+ \if DESKTOPAPI
+ <!-- ------------ DESKTOP PLATFORM -------------- -->
+ \defgroup Desktop_Module Desktop Platform
+ \endif
+
<!-- ------------ MAPS AND LAYERS------------- -->
\defgroup Maps_and_Layers_Module Maps and Layers
-
+
<!-- ------------ RESOURCE SERVICE ------------- -->
\defgroup Resource_Service_Module Resource Service
- <!-- ------------ DRAWING SERVICE --------------- -->
- \defgroup Drawing_Service_Module Drawing Service
- The Drawing Service allows low level access to \link drawing_source drawing sources \endlink
- (DWF data).
-
+ <!-- ------------ FEATURE SERVICE ---------------- -->
+ \defgroup Feature_Service_Module Feature Service
+
<!-- ------------ FEATURE PROPERTIES ------------ -->
\defgroup Feature_Properties_Module Feature Properties
<!-- ------------ FEATURE SCHEMA ---------------- -->
\defgroup Feature_Schema_Module Feature Schema
- <!-- ------------ FEATURE SERVICE ---------------- -->
- \defgroup Feature_Service_Module Feature Service
+ \if MAPGUIDEAPI
+ <!-- ------------ DRAWING SERVICE --------------- -->
+ \defgroup Drawing_Service_Module Drawing Service
+ The Drawing Service allows low level access to \link drawing_source drawing sources \endlink
+ (DWF data).
+
<!-- ------------ MAPPING SERVICE --------------- -->
\defgroup Mapping_Service_Module Mapping Service
@@ -38,6 +45,8 @@
\defgroup Tile_Service_Module Tile Service
The Tile Service supports smooth pans and zooms in the AJAX Viewer.
+ \endif
+
<!-- ------------ COORDINATE SYSTEM ------------- -->
\defgroup Coordinate_System_Module Coordinate System
The Coordinate System classes support coordinate system transformations.
Modified: branches/2.4/MgDev/Doc/group_and_page_definitions/define_pages.h
===================================================================
--- branches/2.4/MgDev/Doc/group_and_page_definitions/define_pages.h 2012-08-29 16:24:48 UTC (rev 6960)
+++ branches/2.4/MgDev/Doc/group_and_page_definitions/define_pages.h 2012-08-29 18:16:56 UTC (rev 6961)
@@ -3,22 +3,28 @@
<!-- This is the index.html page that the user first sees. -->
\section summary \ProdName API Reference
-
+\if MAPGUIDEAPI
For detailed information about using the MapGuide API see the \DevGuide.
-
+\n\n
+\endif
Maps are made up of layers, where each layer displays features from a feature class. See
\ref Maps_and_Layers_Module "Maps and Layers" for more details.
-
+\n\n
Much of the work with this API is done through the following services:
\li \ref Resource_Service_Module "Resource Service": manipulates resources and repositories.
\li \ref Feature_Service_Module "Feature Service": provides access to FDO providers.
+\if DESKTOPAPI
+ \li \ref Desktop_Module "Desktop Platform": Contains classes specific to mg-desktop and extensions to the core MapGuide classes to allow for use in Desktop Applications
+\endif
+\if MAPGUIDEAPI
\li \ref Rendering_Service_Module "Rendering Service": renders a map into a bitmapped image.
\li \ref Drawing_Service_Module "Drawing Service": allows low level access to drawing sources (DWF data).
\li \ref Mapping_Service_Module "Mapping Service": generates eMaps and ePlots for viewing with the DWF Viewer.
\li \ref Profiling_Service_Module "Profiling Service": Profiles map and layer rendering for performance data.
\li \ref Site_Service_Module "Site Service": configures users, groups, and user sessions.
\li \ref Tile_Service_Module "Tile Service": supports smooth pans and zooms in the AJAX Viewer.
+\endif
Some other important areas of the API are:
Modified: branches/2.4/MgDev/Doc/headers_and_footers/header.html
===================================================================
--- branches/2.4/MgDev/Doc/headers_and_footers/header.html 2012-08-29 16:24:48 UTC (rev 6960)
+++ branches/2.4/MgDev/Doc/headers_and_footers/header.html 2012-08-29 18:16:56 UTC (rev 6961)
@@ -18,7 +18,6 @@
<table cellspacing="0" cellpadding="0">
<tbody>
<tr style="height: 56px;">
- <td id="projectlogo"></td>
<!--BEGIN PROJECT_NAME-->
<td style="padding-left: 0.5em;">
<div id="projectname">$projectname
More information about the mapguide-commits
mailing list