diff --git a/.github/workflows/ghpages.yml b/.github/workflows/ghpages.yml index bae56c9..98a7aa1 100644 --- a/.github/workflows/ghpages.yml +++ b/.github/workflows/ghpages.yml @@ -28,7 +28,7 @@ jobs: Invoke-WebRequest -Uri "https://github.com/dotnet/docfx/releases/download/v${env:DOCFXVERSION}/docfx.zip" -OutFile ".tools/docfx/docfx.zip" [System.IO.Compression.ZipFile]::ExtractToDirectory(".tools/docfx/docfx.zip", ".tools/docfx" ) env: - DOCFXVERSION: 2.58 + DOCFXVERSION: 2.59.0 - name: Install .NET OMD Generator run: dotnet tool install --tool-path .tools/omd dotMorten.OmdGenerator --version 1.3.1 @@ -45,10 +45,10 @@ jobs: env: DOCFX_SOURCE_BRANCH_NAME: main run: | - nuget install memberpage -Version 2.58.0 -OutputDirectory docs + nuget install memberpage -Version 2.59.0 -OutputDirectory docs .tools/docfx/docfx.exe metadata docs/docfx.json dotnet build docs/AppliesToGenerator\DocFXAppliesToGenerator.csproj - docs/AppliesToGenerator\bin\Debug\netcoreapp3.1\DocFXAppliesToGenerator.exe docs/appliesToList.json + docs/AppliesToGenerator\bin\Debug\net6.0\DocFXAppliesToGenerator.exe docs/appliesToList.json .tools/docfx/docfx.exe build docs/docfx.json powershell -ExecutionPolicy ByPass -command "docs\FixApiRefLinks" -Path artifacts\docs_site\api\ diff --git a/.gitignore b/.gitignore index 9afbb0f..bd1e85a 100644 --- a/.gitignore +++ b/.gitignore @@ -115,3 +115,4 @@ artifacts .tools docs/memberpage.2.58.0 docs/AppliesToGenerator/.vs +docs/memberpage.2.59.0 diff --git a/docs/AppliesToGenerator/DocFXAppliesToGenerator.csproj b/docs/AppliesToGenerator/DocFXAppliesToGenerator.csproj index c73e0d1..41f1d5a 100644 --- a/docs/AppliesToGenerator/DocFXAppliesToGenerator.csproj +++ b/docs/AppliesToGenerator/DocFXAppliesToGenerator.csproj @@ -2,7 +2,7 @@ Exe - netcoreapp3.1 + net6.0 diff --git a/docs/BuildDoc.cmd b/docs/BuildDoc.cmd index 17c31ac..f20379e 100644 --- a/docs/BuildDoc.cmd +++ b/docs/BuildDoc.cmd @@ -1,6 +1,6 @@ @ECHO OFF -SET DocFXVersion=2.58 +SET DocFXVersion=2.59.0 SET DocFxFolder=%~dp0..\.tools\docfx REM Download DocFx @@ -20,13 +20,14 @@ dotnet tool install --tool-path %~dp0../.tools/omd dotMorten.OmdGenerator --vers mkdir %~dp0../artifacts/docs/api %~dp0..\.tools\omd\generateomd /source=%~dp0../src/NmeaParser /output=%~dp0../artifacts/docs/api/omd.html /preprocessors=NETSTANDARD1_4;NETSTANDARD -%~dp0..\.tools\nuget install memberpage -Version 2.58.0 -OutputDirectory %~dp0 +%~dp0..\.tools\nuget install memberpage -Version %DocFXVersion% -OutputDirectory %~dp0 + REM Build the output site (HTML) from the generated metadata and input files (uses configuration in docfx.json in this folder) %DocFxFolder%\v%DocFXVersion%\docfx.exe metadata %~dp0\docfx.json REM Build applies-to version/framework info dotnet build AppliesToGenerator\DocFXAppliesToGenerator.csproj -AppliesToGenerator\bin\Debug\netcoreapp3.1\DocFXAppliesToGenerator.exe appliesToList.json +AppliesToGenerator\bin\Debug\net6.0\DocFXAppliesToGenerator.exe appliesToList.json %DocFxFolder%\v%DocFXVersion%\docfx.exe build %~dp0\docfx.json diff --git a/docs/appliesToList.json b/docs/appliesToList.json index 3e3fd57..c5a3a0d 100644 --- a/docs/appliesToList.json +++ b/docs/appliesToList.json @@ -54,6 +54,34 @@ { "Name" : "v2.1", "Manifest": "manifests/v2.1/uwp/.manifest" }, { "Name" : "v2.0", "Manifest": "manifests/v2.0/uwp/.manifest" } ] - } + }, + { + "PlatformName": ".NET 6+", + "Versions" : [ + { "Name": "GitHub", "Manifest": "../artifacts/docs/api/net/.manifest" }, + { "Name" : "v2.3", "Manifest": "manifests/v2.3/net/.manifest" } + ] + }, + { + "PlatformName": ".NET Android", + "Versions" : [ + { "Name": "GitHub", "Manifest": "../artifacts/docs/api/net-android/.manifest" }, + { "Name" : "v2.3", "Manifest": "manifests/v2.3/net-android/.manifest" } + ] + }, + { + "PlatformName": ".NET iOS", + "Versions" : [ + { "Name": "GitHub", "Manifest": "../artifacts/docs/api/net-ios/.manifest" }, + { "Name" : "v2.3", "Manifest": "manifests/v2.3/net-ios/.manifest" } + ] + }, + { + "PlatformName": ".NET Windows", + "Versions" : [ + { "Name": "GitHub", "Manifest": "../artifacts/docs/api/net-windows/.manifest" }, + { "Name" : "v2.3", "Manifest": "manifests/v2.3/net-windows/.manifest" } + ] + }, ] } \ No newline at end of file diff --git a/docs/docfx.json b/docs/docfx.json index d35cfc8..4a5581a 100644 --- a/docs/docfx.json +++ b/docs/docfx.json @@ -6,62 +6,84 @@ "files": [ "NmeaParser/NmeaParser.csproj" ], "src" : "../src/" }, - ], + ], "dest": "../artifacts/docs/api/netstd", "properties": { "TargetFramework": "netstandard1.4" }, "disableGitFeatures": false, "disableDefaultFilter": false }, - { "src": [ + { "src": [ { "files": [ "NmeaParser/NmeaParser.csproj" ], "src" : "../src/" } - ], + ], "dest": "../artifacts/docs/api/netfx", "properties": { "TargetFramework": "net452" }, "disableGitFeatures": false, "disableDefaultFilter": false }, - { "src": [ + { "src": [ { "files": [ "NmeaParser/NmeaParser.csproj" ], "src" : "../src/" } - ], - "dest": "../artifacts/docs/api/netcore", - "properties": { "TargetFramework": "netcoreapp2.1" }, - "disableGitFeatures": false, - "disableDefaultFilter": false - }, - { "src": [ - { - "files": [ "NmeaParser/NmeaParser.csproj" ], - "src" : "../src/" - } - ], + ], "dest": "../artifacts/docs/api/android", "properties": { "TargetFramework": "monoandroid70" }, "disableGitFeatures": false, "disableDefaultFilter": false }, - { "src": [ + { "src": [ { "files": [ "NmeaParser/NmeaParser.csproj" ], "src" : "../src/" } - ], + ], + "dest": "../artifacts/docs/api/net-android", + "properties": { "TargetFramework": "net7.0-android" }, + "disableGitFeatures": false, + "disableDefaultFilter": false + }, + { "src": [ + { + "files": [ "NmeaParser/NmeaParser.csproj" ], + "src" : "../src/" + } + ], "dest": "../artifacts/docs/api/ios", "properties": { "TargetFramework": "xamarinios10" }, "disableGitFeatures": false, "disableDefaultFilter": false }, - { "src": [ + { "src": [ { "files": [ "NmeaParser/NmeaParser.csproj" ], "src" : "../src/" } - ], + ], + "dest": "../artifacts/docs/api/net-ios", + "properties": { "TargetFramework": "net7.0-ios" }, + "disableGitFeatures": false, + "disableDefaultFilter": false + }, + { "src": [ + { + "files": [ "NmeaParser/NmeaParser.csproj" ], + "src" : "../src/" + } + ], + "dest": "../artifacts/docs/api/net-windows", + "properties": { "TargetFramework": "net6.0-windows10.0.19041.0" }, + "disableGitFeatures": false, + "disableDefaultFilter": false + }, + { "src": [ + { + "files": [ "NmeaParser/NmeaParser.csproj" ], + "src" : "../src/" + } + ], "dest": "../artifacts/docs/api/uwp", "properties": { "TargetFramework": "uap10.0.18362" }, "disableGitFeatures": false, @@ -70,7 +92,7 @@ ], "build": { "content": [ - { + { "files": [ "api/**/index.md" ] @@ -80,7 +102,7 @@ "api/**.yml", "api/**/toc.yml" ], - "src" : "../artifacts/docs" + "src" : "../artifacts/docs" }, { "files": [ @@ -98,11 +120,11 @@ "favicon.ico" ] }, - { + { "files": [ "api/omd.html" ], - "src" : "../artifacts/docs" + "src" : "../artifacts/docs" } ], "overwrite": [ @@ -134,7 +156,7 @@ "fileMetadataFiles": [], "template": [ "default", - "memberpage.2.58.0/content", + "memberpage.2.59.0/content", "template_overrides" ], "postProcessors": [], diff --git a/src/NmeaParser/BluetoothDevice.Android.cs b/src/NmeaParser/BluetoothDevice.Android.cs index a0a51cf..b83fb3b 100644 --- a/src/NmeaParser/BluetoothDevice.Android.cs +++ b/src/NmeaParser/BluetoothDevice.Android.cs @@ -51,6 +51,9 @@ namespace NmeaParser /// /// A set of bluetooth devices available that supports serial connections [Obsolete("Use GetBluetoothSerialDevices(Context)")] +#if NETCOREAPP + [System.Runtime.Versioning.ObsoletedOSPlatform("android31.0")] +#endif public static IEnumerable GetBluetoothSerialDevices() { var adapter = Android.Bluetooth.BluetoothAdapter.DefaultAdapter; @@ -110,7 +113,9 @@ namespace NmeaParser else { #pragma warning disable CS0618 // Type or member is obsolete. Only used if deprecated constructor is used +#pragma warning disable CA1422 // Validate platform compatibility adapter = Android.Bluetooth.BluetoothAdapter.DefaultAdapter; +#pragma warning restore CA1422 // Validate platform compatibility #pragma warning restore CS0618 // Type or member is obsolete } if (adapter?.IsEnabled != true) diff --git a/src/NmeaParser/NmeaParser.csproj b/src/NmeaParser/NmeaParser.csproj index 7e160d1..c00cdd4 100644 --- a/src/NmeaParser/NmeaParser.csproj +++ b/src/NmeaParser/NmeaParser.csproj @@ -2,7 +2,7 @@ - netstandard2.0;netstandard1.4;netcoreapp2.1;net452;monoandroid50;monoandroid70;xamarinios10;uap10.0.18362;net6.0;net7.0-ios;net7.0-android;net6.0-windows10.0.19041.0 + netstandard2.0;netstandard1.4;net452;monoandroid50;monoandroid70;xamarinios10;uap10.0.18362;net6.0;net7.0-ios;net7.0-android;net6.0-windows10.0.19041.0 true true Debug;Release