[V4] API Documentation Generation Initial Changes (#3399)

aws · Jul 31, 2024 · 391da90 · 391da90
1 parent e67b7d1
commit 391da90
Show file tree

Hide file tree

Showing 23 changed files with 174 additions and 172 deletions.
diff --git a/buildtools/NoticeForZips.txt b/buildtools/NoticeForZips.txt
@@ -71,4 +71,87 @@ EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 
 This software consists of voluntary contributions made by many individuals on behalf of the vbAccelerator. For more information, please see http://vbaccelerator.com/ .
 
-The vbAccelerator licence is based on the Apache Software Foundation Software Licence, Copyright (c) 2000 The Apache Software Foundation. All rights reserved.
+The vbAccelerator licence is based on the Apache Software Foundation Software Licence, Copyright (c) 2000 The Apache Software Foundation. All rights reserved.
+
+----------------
+
+** System.Buffers
+
+The MIT License (MIT)
+
+Copyright (c) .NET Foundation and Contributors
+
+All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+
+----------------
+
+** System.Memory
+
+The MIT License (MIT)
+
+Copyright (c) .NET Foundation and Contributors
+
+All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+----------------
+
+** System.Text.Json
+
+The MIT License (MIT)
+
+Copyright (c) .NET Foundation and Contributors
+
+All rights reserved.
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/docgenerator/SDKDocGenerator.UnitTests/SDKDocGenerator.UnitTests.csproj b/docgenerator/SDKDocGenerator.UnitTests/SDKDocGenerator.UnitTests.csproj
@@ -11,9 +11,10 @@
     <AppDesignerFolder>Properties</AppDesignerFolder>
     <RootNamespace>SDKDocGenerator.UnitTests</RootNamespace>
     <AssemblyName>SDKDocGenerator.UnitTests</AssemblyName>
-    <TargetFrameworkVersion>v4.5</TargetFrameworkVersion>
+    <TargetFrameworkVersion>v4.7.2</TargetFrameworkVersion>
     <FileAlignment>512</FileAlignment>
     <NuGetPackageImportStamp>5505627e</NuGetPackageImportStamp>
+    <TargetFrameworkProfile />
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
     <DebugSymbols>true</DebugSymbols>

diff --git a/docgenerator/SDKDocGenerator.UnitTests/packages.config b/docgenerator/SDKDocGenerator.UnitTests/packages.config
@@ -1,10 +1,10 @@
 <?xml version="1.0" encoding="utf-8"?>
 <packages>
-  <package id="xunit" version="2.1.0" targetFramework="net45" />
-  <package id="xunit.abstractions" version="2.0.0" targetFramework="net45" />
-  <package id="xunit.assert" version="2.1.0" targetFramework="net45" />
-  <package id="xunit.core" version="2.1.0" targetFramework="net45" />
-  <package id="xunit.extensibility.core" version="2.1.0" targetFramework="net45" />
-  <package id="xunit.extensibility.execution" version="2.1.0" targetFramework="net45" />
-  <package id="xunit.runner.visualstudio" version="2.1.0" targetFramework="net45" />
+  <package id="xunit" version="2.1.0" targetFramework="net472" />
+  <package id="xunit.abstractions" version="2.0.0" targetFramework="net472" />
+  <package id="xunit.assert" version="2.1.0" targetFramework="net472" />
+  <package id="xunit.core" version="2.1.0" targetFramework="net472" />
+  <package id="xunit.extensibility.core" version="2.1.0" targetFramework="net472" />
+  <package id="xunit.extensibility.execution" version="2.1.0" targetFramework="net472" />
+  <package id="xunit.runner.visualstudio" version="2.1.0" targetFramework="net472" />
 </packages>
diff --git a/docgenerator/SDKDocGenerator/App.config b/docgenerator/SDKDocGenerator/App.config
@@ -1,6 +1,6 @@
-<?xml version="1.0" encoding="utf-8" ?>
+<?xml version="1.0" encoding="utf-8"?>
 <configuration>
     <startup> 
-        <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.5" />
+        <supportedRuntime version="v4.0" sku=".NETFramework,Version=v4.7.2"/>
     </startup>
 </configuration>
diff --git a/docgenerator/SDKDocGenerator/CommandLineParser.cs b/docgenerator/SDKDocGenerator/CommandLineParser.cs
@@ -209,7 +209,7 @@ class ArgDeclaration
                 HasValue = true,
                 Parse = (arguments, argValue) => arguments.ParsedOptions.Platform = argValue,
                 HelpText = "The primary platform subfolder used for assembly discovery, controlling which assemblies get used in doc generation. "
-                            + "'net45', or the first available subfolder, is used if not specified."
+                            + "'net472', or the first available subfolder, is used if not specified."
             },    
             new ArgDeclaration
             {

diff --git a/docgenerator/SDKDocGenerator/SDKDocGenerator.csproj b/docgenerator/SDKDocGenerator/SDKDocGenerator.csproj
@@ -9,8 +9,9 @@
     <AppDesignerFolder>Properties</AppDesignerFolder>
     <RootNamespace>SDKDocGenerator</RootNamespace>
     <AssemblyName>SDKDocGenerator</AssemblyName>
-    <TargetFrameworkVersion>v4.5</TargetFrameworkVersion>
+    <TargetFrameworkVersion>v4.7.2</TargetFrameworkVersion>
     <FileAlignment>512</FileAlignment>
+    <TargetFrameworkProfile />
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
     <PlatformTarget>AnyCPU</PlatformTarget>

diff --git a/docgenerator/SDKDocGeneratorLib/FrameworkVersion.cs b/docgenerator/SDKDocGeneratorLib/FrameworkVersion.cs
@@ -7,8 +7,7 @@ namespace SDKDocGenerator
     /// </summary>
     public class FrameworkVersion : MarshalByRefObject
     {
-        public readonly static FrameworkVersion DotNet35 = new FrameworkVersion(".NET Framework 3.5", "NET3_5");
-        public readonly static FrameworkVersion DotNet45 = new FrameworkVersion(".NET Framework 4.5", "NET4_5");
+        public readonly static FrameworkVersion DotNet472 = new FrameworkVersion(".NET Framework 4.7.2", "NET4_7_2");
 
         public FrameworkVersion(string displayName, string shortName)
         {
@@ -35,10 +34,7 @@ public override string ToString()
 
         public static FrameworkVersion FromPlatformFolder(string platformFolder)
         {
-            if (platformFolder.Equals("net35", StringComparison.OrdinalIgnoreCase))
-                return DotNet35;
-
-            return DotNet45;
+            return DotNet472;
         }
     }
 }
diff --git a/docgenerator/SDKDocGeneratorLib/GenerationManifest.cs b/docgenerator/SDKDocGeneratorLib/GenerationManifest.cs
@@ -26,7 +26,7 @@ public class GenerationManifest
         /// <summary>
         /// The preferred platform against which we generate documentation, if it's available.
         /// </summary>
-        public const string PreferredPlatform = "net45";
+        public const string PreferredPlatform = "net472";
 
         /// <summary>
         /// Represents a single service, supported on one or more platforms, that we will be

diff --git a/docgenerator/SDKDocGeneratorLib/GeneratorOptions.cs b/docgenerator/SDKDocGeneratorLib/GeneratorOptions.cs
@@ -105,7 +105,7 @@ public string ComputedContentFolder
 
         /// <summary>
         /// Constructs default options for the generator, which are to process
-        /// all services found for the .Net 4.5 platform, and emit the doc 
+        /// all services found for the .Net 4.7.2 platform, and emit the doc 
         /// framework static content files. The default paths are relative to 
         /// the executing generator assembly.
         /// </summary>
@@ -118,7 +118,7 @@ public GeneratorOptions()
             // we don't default the sdk assembly root, as it can
             // change between invoking from within Visual Studio
             // or via our build scripts
-            Platform = "net45";
+            Platform = "net472";
             Services = new [] { "*" };
             OutputFolder = @"..\..\..\..\Deployment\docs";
             ContentSubFolderName = "items";

diff --git a/docgenerator/SDKDocGeneratorLib/SDKDocGeneratorLib.csproj b/docgenerator/SDKDocGeneratorLib/SDKDocGeneratorLib.csproj
@@ -9,8 +9,9 @@
     <AppDesignerFolder>Properties</AppDesignerFolder>
     <RootNamespace>SDKDocGenerator</RootNamespace>
     <AssemblyName>SDKDocGeneratorLib</AssemblyName>
-    <TargetFrameworkVersion>v4.5</TargetFrameworkVersion>
+    <TargetFrameworkVersion>v4.7.2</TargetFrameworkVersion>
     <FileAlignment>512</FileAlignment>
+    <TargetFrameworkProfile />
   </PropertyGroup>
   <PropertyGroup Condition=" '$(Configuration)|$(Platform)' == 'Debug|AnyCPU' ">
     <DebugSymbols>true</DebugSymbols>
@@ -89,7 +90,7 @@
     <Content Include="output-files\resources\parentloader.js">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </Content>
-    <Content Include="output-files\v3-migration.html">
+    <Content Include="output-files\v4-migration.html">
       <CopyToOutputDirectory>Always</CopyToOutputDirectory>
     </Content>
     <EmbeddedResource Include="Templates\sdk-api-home.html" />

diff --git a/docgenerator/SDKDocGeneratorLib/SdkDocGenerator.cs b/docgenerator/SDKDocGeneratorLib/SdkDocGenerator.cs
@@ -8,7 +8,7 @@
 namespace SDKDocGenerator
 {
     /// <summary>
-    /// Documentation generator for the AWS SDK for .NET v3+ codebase.
+    /// Documentation generator for the AWS SDK for .NET v4+ codebase.
     /// </summary>
     public class SdkDocGenerator
     {
@@ -190,7 +190,7 @@ private void CopyVersionInfoManifest()
         /// <summary>
         /// Enumerates the assembly, folder and platform settings in the options
         /// to construct a per-service manifest that we will then process. Our preferred
-        /// documentation source is for the 'net45' platform but if a subfolder does
+        /// documentation source is for the 'net472' platform but if a subfolder does
         /// not exist under the root for this platform, we'll generate using the
         /// assemblies in the first subfolder we find.
         /// </summary>

diff --git a/docgenerator/SDKDocGeneratorLib/Templates/TOC.html b/docgenerator/SDKDocGeneratorLib/Templates/TOC.html
@@ -2,10 +2,10 @@
 <html lang="en-GB">
 <head>
     <meta name="guide-name" content="API Reference" />
-    <meta name="service-name" content="AWS SDK for .NET Version 3" />
+    <meta name="service-name" content="AWS SDK for .NET Version 4" />
     <meta http-equiv="Content-Type" content="text/html;charset=utf-8">
     <link rel="stylesheet" type="text/css" href="./resources/tocstyle.css" media="screen">
-    <title>API Reference - Table of Contents | AWS SDK for .NET Version 3</title>
+    <title>API Reference - Table of Contents | AWS SDK for .NET Version 4</title>
 </head>
 <body>
     <button id="skipToMain" tabindex="0">Skip to main content</button>