Changes between Initial Version and Version 1 of Ticket #2877


Ignore:
Timestamp:
Nov 10, 2023, 12:27:26 PM (6 months ago)
Author:
jng
Comment:

Legend:

Unmodified
Added
Removed
Modified

  • Ticket #2877 – Description

    initial v1  
    1515Task breakdown:
    1616
    17  * [ ] Add helper script to acquire required documentation tools
    18  * [ ] Add docfx project
     17 * [x] Add helper script to acquire required documentation tools
     18 * [x] Add docfx project
    1919 * [ ] Update IMake to support generation of PHP stub classes with transferred API documentation
    20  * [ ] Add top-level doc build script to run docfx, javadoc and doctum against their respective proxy class source files
    21  * [ ] Convert all doxygen conceptual topics over to markdown .md files
    22  * [ ] Determine a suitable static site generator that supports code syntax highlighting in Java, C# and PHP
    23  * [ ] Add a static landing site that links to the docfx, javadoc and doctum generated API docs
    24  * [ ] Add conceptual topics to the landing site
     20 * [x] Add top-level doc build script to run docfx, javadoc and doctum against their respective proxy class source files
     21 * [~] Convert all doxygen conceptual topics over to markdown .md files
     22 * [x] Determine a suitable static site generator that supports code syntax highlighting in Java, C# and PHP (we chose docfx)
     23 * [x] Add a static landing site that links to the docfx, javadoc and doctum generated API docs
     24 * [ ] Java: Document unique features of the Java binding (mine MapGuide RFC 129 and 185 for content)
     25 * [ ] .net: Document unique features of the .net binding (mine MapGuide RFC 185 for content)
     26 * [ ] PHP: Document the fact that `constants.php` no longer exists and the constant defns are now baked into the PHP extension itself
     27 * [~] Add conceptual topics to the landing site
    2528 * [ ] Package zip of the landing site with the 3 language-specific API docs