Opened 16 years ago
Closed 15 years ago
#406 closed enhancement (fixed)
Improvements to the look and feel of the FDO component API reference documents.
Reported by: | donaldcameron | Owned by: | Donald Cameron |
---|---|---|---|
Priority: | major | Milestone: | 3.4.0 |
Component: | Documentation | Version: | 3.3.1 |
Severity: | 3 | Keywords: | API Reference |
Cc: | External ID: |
Description
The objective is to improve the look and feel of the API reference documents and to add some new reference documents. The API reference documents are html documents that are created by doxygen from source code header files, topic files (dummy .h files), and formatting files (header and footer html files and css files). The improvement is achieved by doing some processing prior to and after calling doxygen.
The topic content is contained in files named define_pages*.h. The formatting files are named header*.html and footer.html. There is a common set of css files used for all FDO component API reference documents. They are osgeo.css and geospatial.css. There is an associated javascript file for creating the banner. It is named geospatial.js. Minor changes were made to the doxygen configuration files for each component. A build script has been written to automate the generation of the html files and their subsequent packaging for distribution. The first release of the documents in their new format is pending.
The reference documents being added are as follows:
- KingOracle C++ API Reference
- MySQL C# API Reference
- PostGIS C++ API Reference
- SHP C# API Reference
- SQLServerSpatial C++ API Reference
- SQLServerSpatial C# API Reference
- WMS C# API Reference
The first submission against this ticket will be all of the above-mentioned files with the exception of the CSS and javascript files and the build script. The second submission will contain the latter files.