[mapguide-commits] r10079 - in branches/4.0/MgDev: . Bindings

[svn_mapguide at osgeo.org]

Author: jng
Date: 2024-07-09 06:11:44 -0700 (Tue, 09 Jul 2024)
New Revision: 10079

Modified:
   branches/4.0/MgDev/Bindings/TODO.txt
   branches/4.0/MgDev/acquire-doctools.ps1
Log:
Drop plans for PHP API documentation. We'll only target .net/Java. The problem is that PHP has language limitations (namely it doesn't support overloaded constructors/methods) that prevent us from easily translating the C++ API surface to PHP

Modified: branches/4.0/MgDev/Bindings/TODO.txt
===================================================================
--- branches/4.0/MgDev/Bindings/TODO.txt	2024-07-02 01:55:44 UTC (rev 10078)
+++ branches/4.0/MgDev/Bindings/TODO.txt	2024-07-09 13:11:44 UTC (rev 10079)
@@ -121,14 +121,9 @@
       - Add -> AddItem
  - Revise API documentation strategy
    - [ ] Don't use doxygen. Instead use the appropriate docgen tool for the languages we support:
-     - PHP: phpDocumentor (https://phpdoc.org/)
      - Java: javadoc (part of the JDK)
      - .net: docfx (https://dotnet.github.io/docfx/)
-   - [ ] Implement a static umbrella landing site that is the gateway to the 3 generated outputs
- - IMake
-   - [ ] Support generating generated stubs of PHP classes with transplanted documentation
-     - For ease of implementation, we could probably resurrect the PHP constants.php generation mode, except it now covers all classes and not just constants
-     - [ ] Determine a suitable PHP API documentation tool that can generate API docs against these documented PHP stub classes
+   - [ ] Implement a static umbrella landing site that is the gateway to the language-specific generated outputs
  - mg-desktop
    - [x] Rename to MgPortable/mg-portable
    - [ ] Add SWIG glue library that layers on top of the existing Foundation/Geometry/PlatformBase glue projects

Modified: branches/4.0/MgDev/acquire-doctools.ps1
===================================================================
--- branches/4.0/MgDev/acquire-doctools.ps1	2024-07-02 01:55:44 UTC (rev 10078)
+++ branches/4.0/MgDev/acquire-doctools.ps1	2024-07-09 13:11:44 UTC (rev 10079)
@@ -1,9 +1,2 @@
 Write-Host "Ensuring docfx is installed"
-dotnet tool update -g docfx
-Write-Host "Ensuring doctum is installed"
-if (Test-Path ./BuildTools/doctum.phar) {
-    Write-Host "doctum.phar is installed in the expected path"
-} else {
-    Write-Host "doctum.phar not found. Downloading it"
-    Invoke-WebRequest https://doctum.long-term.support/releases/latest/doctum.phar -OutFile ./BuildTools/doctum.phar
-}
\ No newline at end of file
+dotnet tool update -g docfx
\ No newline at end of file