search

xamarin / xamarin-macios

.NET for iOS, Mac Catalyst, macOS, and tvOS provide open-source bindings of the Apple SDKs for use with .NET managed languages such as C#
Other
2.42k stars 504 forks source link

[bgen] Generate xml documentation for the extension class we generate for protocols. #20564

Closed rolfbjarne closed 2 months ago

rolfbjarne commented 2 months ago

This was mostly copied from the existing API documentation.

Partial fix for https://github.com/xamarin/xamarin-macios/issues/20270.

vs-mobiletools-engineering-service2 commented 2 months ago

:fire: [PR Build] Build failed :fire:

Build failed for the job 'Build packages'

Pipeline on Agent Hash: 4bd9b9270adc3d1e079b42952677ef0e9eea4367 [PR build]

vs-mobiletools-engineering-service2 commented 2 months ago

:fire: [PR Build] Build failed :fire:

Build failed for the job 'Detect API changes'

Pipeline on Agent Hash: 4bd9b9270adc3d1e079b42952677ef0e9eea4367 [PR build]

vs-mobiletools-engineering-service2 commented 2 months ago

:computer: [PR Build] Tests on macOS X64 - Mac Sonoma (14) passed :computer:

:white_check_mark: All tests on macOS X64 - Mac Sonoma (14) passed.

Pipeline on Agent Hash: [PR build]

vs-mobiletools-engineering-service2 commented 2 months ago

:fire: [CI Build] Test results :fire:

Test results

:x: Tests failed on VSTS: test results

26 tests crashed, 0 tests failed, 0 tests passed.

Failures

:x: cecil tests

:fire: Failed catastrophically on VSTS: test results - cecil (no summary found).

Html Report (VSDrops) Download

:x: dotnettests tests (iOS)

:fire: Failed catastrophically on VSTS: test results - dotnettests_ios (no summary found).

Html Report (VSDrops) Download

:x: dotnettests tests (MacCatalyst)

:fire: Failed catastrophically on VSTS: test results - dotnettests_maccatalyst (no summary found).

Html Report (VSDrops) Download

:x: dotnettests tests (macOS)

:fire: Failed catastrophically on VSTS: test results - dotnettests_macos (no summary found).

Html Report (VSDrops) Download

:x: dotnettests tests (Multiple platforms)

:fire: Failed catastrophically on VSTS: test results - dotnettests_multiple (no summary found).

Html Report (VSDrops) Download

:x: dotnettests tests (tvOS)

:fire: Failed catastrophically on VSTS: test results - dotnettests_tvos (no summary found).

Html Report (VSDrops) Download

:x: framework tests

:fire: Failed catastrophically on VSTS: test results - framework (no summary found).

Html Report (VSDrops) Download

:x: fsharp tests

:fire: Failed catastrophically on VSTS: test results - fsharp (no summary found).

Html Report (VSDrops) Download

:x: generator tests

:fire: Failed catastrophically on VSTS: test results - generator (no summary found).

Html Report (VSDrops) Download

:x: install-source tests

:fire: Failed catastrophically on VSTS: test results - install-source (no summary found).

Html Report (VSDrops) Download

:x: interdependent-binding-projects tests

:fire: Failed catastrophically on VSTS: test results - interdependent-binding-projects (no summary found).

Html Report (VSDrops) Download

:x: introspection tests

:fire: Failed catastrophically on VSTS: test results - introspection (no summary found).

Html Report (VSDrops) Download

:x: linker tests

:fire: Failed catastrophically on VSTS: test results - linker (no summary found).

Html Report (VSDrops) Download

:x: mac-binding-project tests

:fire: Failed catastrophically on VSTS: test results - mac-binding-project (no summary found).

Html Report (VSDrops) Download

:x: mmp tests

:fire: Failed catastrophically on VSTS: test results - mmp (no summary found).

Html Report (VSDrops) Download

:x: mononative tests

:fire: Failed catastrophically on VSTS: test results - mononative (no summary found).

Html Report (VSDrops) Download

:x: monotouch tests (iOS)

:fire: Failed catastrophically on VSTS: test results - monotouch_ios (no summary found).

Html Report (VSDrops) Download

:x: monotouch tests (MacCatalyst)

:fire: Failed catastrophically on VSTS: test results - monotouch_maccatalyst (no summary found).

Html Report (VSDrops) Download

:x: monotouch tests (macOS)

:fire: Failed catastrophically on VSTS: test results - monotouch_macos (no summary found).

Html Report (VSDrops) Download

:x: monotouch tests (tvOS)

:fire: Failed catastrophically on VSTS: test results - monotouch_tvos (no summary found).

Html Report (VSDrops) Download

:x: monotouch tests (watchOS)

:fire: Failed catastrophically on VSTS: test results - monotouch_watchos (no summary found).

Html Report (VSDrops) Download

:x: msbuild tests

:fire: Failed catastrophically on VSTS: test results - msbuild (no summary found).

Html Report (VSDrops) Download

:x: mtouch tests

:fire: Failed catastrophically on VSTS: test results - mtouch (no summary found).

Html Report (VSDrops) Download

:x: xammac tests

:fire: Failed catastrophically on VSTS: test results - xammac (no summary found).

Html Report (VSDrops) Download

:x: xcframework tests

:fire: Failed catastrophically on VSTS: test results - xcframework (no summary found).

Html Report (VSDrops) Download

:x: xtro tests

:fire: Failed catastrophically on VSTS: test results - xtro (no summary found).

Html Report (VSDrops) Download

Successes

Pipeline on Agent Hash: [PR build]

vs-mobiletools-engineering-service2 commented 2 months ago

:computer: [PR Build] Tests on macOS M1 - Mac Ventura (13) passed :computer:

:white_check_mark: All tests on macOS M1 - Mac Ventura (13) passed.

Pipeline on Agent Hash: [PR build]

vs-mobiletools-engineering-service2 commented 2 months ago

:computer: [PR Build] Tests on macOS M1 - Mac Big Sur (11) passed :computer:

:white_check_mark: All tests on macOS M1 - Mac Big Sur (11) passed.

Pipeline on Agent Hash: [PR build]

vs-mobiletools-engineering-service2 commented 2 months ago

:computer: [PR Build] Tests on macOS M1 - Mac Monterey (12) passed :computer:

:white_check_mark: All tests on macOS M1 - Mac Monterey (12) passed.

Pipeline on Agent Hash: [PR build]

vs-mobiletools-engineering-service2 commented 2 months ago

:books: [PR Build] Artifacts :books:

Packages generated

View packages * [xamarin.ios-17.3.0.414.pkg](https://dl.internalx.com/wrench/merge/06f9a1c28ef2089b4033df2128cf29b277041d29/9533220/package/xamarin.ios-17.3.0.414.pkg) * [xamarin.mac-9.3.0.414.pkg](https://dl.internalx.com/wrench/merge/06f9a1c28ef2089b4033df2128cf29b277041d29/9533220/package/xamarin.mac-9.3.0.414.pkg)

Pipeline on Agent Hash: [PR build]

vs-mobiletools-engineering-service2 commented 2 months ago

:computer: [PR Build] Tests on macOS X64 - Mac Sonoma (14) passed :computer:

:white_check_mark: All tests on macOS X64 - Mac Sonoma (14) passed.

Pipeline on Agent Hash: [PR build]

vs-mobiletools-engineering-service2 commented 2 months ago

:computer: [PR Build] Tests on macOS M1 - Mac Monterey (12) passed :computer:

:white_check_mark: All tests on macOS M1 - Mac Monterey (12) passed.

Pipeline on Agent Hash: [PR build]

vs-mobiletools-engineering-service2 commented 2 months ago

:computer: [PR Build] Tests on macOS M1 - Mac Ventura (13) passed :computer:

:white_check_mark: All tests on macOS M1 - Mac Ventura (13) passed.

Pipeline on Agent Hash: [PR build]

vs-mobiletools-engineering-service2 commented 2 months ago

:computer: [PR Build] Tests on macOS M1 - Mac Big Sur (11) passed :computer:

:white_check_mark: All tests on macOS M1 - Mac Big Sur (11) passed.

Pipeline on Agent Hash: [PR build]

vs-mobiletools-engineering-service2 commented 2 months ago

:computer: [CI Build] Windows Integration Tests passed :computer:

:white_check_mark: All Windows Integration Tests passed.

Pipeline on Agent Hash: 5c2868b6a757ec5fad65a1a9921d450ebc6f7903 [PR build]

vs-mobiletools-engineering-service2 commented 2 months ago

:white_check_mark: API diff for current PR / commit

Legacy Xamarin (No breaking changes) * ~iOS~ (no change detected) * ~tvOS~ (no change detected) * ~watchOS~ (no change detected) * ~macOS~ (no change detected)
NET (empty diffs) * ~iOS~: (empty diff detected) * ~tvOS~: (empty diff detected) * ~MacCatalyst~: (empty diff detected) * ~macOS~: (empty diff detected)

:white_check_mark: API diff vs stable

Legacy Xamarin (No breaking changes) * iOS: [vsdrops](https://vsdrop.corp.microsoft.com/file/v1/xamarin-macios/detected-changes/20240506.14/9533220-1/;/stable-api-comparison/ios-api-diff.html) [gist](https://gist.github.com/vs-mobiletools-engineering-service2/d183df59aff0b228ba99e43b84f59ae6) (No breaking changes) * tvOS: [vsdrops](https://vsdrop.corp.microsoft.com/file/v1/xamarin-macios/detected-changes/20240506.14/9533220-1/;/stable-api-comparison/tvos-api-diff.html) [gist](https://gist.github.com/vs-mobiletools-engineering-service2/d84da19e62e3bc8a09d8ae9e15ad01cb) (No breaking changes) * watchOS: [vsdrops](https://vsdrop.corp.microsoft.com/file/v1/xamarin-macios/detected-changes/20240506.14/9533220-1/;/stable-api-comparison/watchos-api-diff.html) [gist](https://gist.github.com/vs-mobiletools-engineering-service2/119a2a153d33a89a5fa9e450dc524247) (No breaking changes) * macOS: [vsdrops](https://vsdrop.corp.microsoft.com/file/v1/xamarin-macios/detected-changes/20240506.14/9533220-1/;/stable-api-comparison/mac-api-diff.html) [gist](https://gist.github.com/vs-mobiletools-engineering-service2/d74484ccc72dd1c18bab45a23cebf13a) (No breaking changes)
.NET (No breaking changes) * iOS: [vsdrops](https://vsdrop.corp.microsoft.com/file/v1/xamarin-macios/detected-changes/20240506.14/9533220-1/;/stable-api-comparison/diff/dotnet/Microsoft.iOS.Ref/ref/net8.0/Microsoft.iOS.html) [gist](https://gist.github.com/vs-mobiletools-engineering-service2/d7d95509b4c8f5e558868e09f2b890e0) (No breaking changes) * tvOS: [vsdrops](https://vsdrop.corp.microsoft.com/file/v1/xamarin-macios/detected-changes/20240506.14/9533220-1/;/stable-api-comparison/diff/dotnet/Microsoft.tvOS.Ref/ref/net8.0/Microsoft.tvOS.html) [gist](https://gist.github.com/vs-mobiletools-engineering-service2/3fcf3f705b420bced0cf7e18ec15e201) (No breaking changes) * MacCatalyst: [vsdrops](https://vsdrop.corp.microsoft.com/file/v1/xamarin-macios/detected-changes/20240506.14/9533220-1/;/stable-api-comparison/diff/dotnet/Microsoft.MacCatalyst.Ref/ref/net8.0/Microsoft.MacCatalyst.html) [gist](https://gist.github.com/vs-mobiletools-engineering-service2/ec01828330bc734b42c50bfd85524817) (No breaking changes) * macOS: [vsdrops](https://vsdrop.corp.microsoft.com/file/v1/xamarin-macios/detected-changes/20240506.14/9533220-1/;/stable-api-comparison/diff/dotnet/Microsoft.macOS.Ref/ref/net8.0/Microsoft.macOS.html) [gist](https://gist.github.com/vs-mobiletools-engineering-service2/5a0e301bda6b59903bad2819faa23ddd) (No breaking changes) * Microsoft.iOS vs Microsoft.MacCatalyst: [vsdrops](https://vsdrop.corp.microsoft.com/file/v1/xamarin-macios/detected-changes/20240506.14/9533220-1/;/stable-api-comparison/diff/dotnet/iOS-MacCatalyst-diff/Microsoft.iOS.Ref/ref/net8.0/Microsoft.iOS.MacCatalyst.html) [gist](https://gist.github.com/vs-mobiletools-engineering-service2/ddeea165f78a7da00be940c728405ea5)
Legacy Xamarin (stable) vs .NET * iOS: [vsdrops](https://vsdrop.corp.microsoft.com/file/v1/xamarin-macios/detected-changes/20240506.14/9533220-1/;/stable-api-comparison/diff/dotnet/legacy-diff/Microsoft.iOS.Ref/ref/net8.0/Microsoft.iOS.html) [gist](https://gist.github.com/vs-mobiletools-engineering-service2/ad9ff256838e754a191ef240a3d5ebb4) * tvOS: [vsdrops](https://vsdrop.corp.microsoft.com/file/v1/xamarin-macios/detected-changes/20240506.14/9533220-1/;/stable-api-comparison/diff/dotnet/legacy-diff/Microsoft.tvOS.Ref/ref/net8.0/Microsoft.tvOS.html) [gist](https://gist.github.com/vs-mobiletools-engineering-service2/5aa5992e8d53461a1e4f988126da0a09) * macOS: [vsdrops](https://vsdrop.corp.microsoft.com/file/v1/xamarin-macios/detected-changes/20240506.14/9533220-1/;/stable-api-comparison/diff/dotnet/legacy-diff/Microsoft.macOS.Ref/ref/net8.0/Microsoft.macOS.html) [gist](https://gist.github.com/vs-mobiletools-engineering-service2/a8abc3d1dd3a90270d4e585ee18f55a5)

:information_source: Generator diff

Generator Diff: vsdrops (html) vsdrops (raw diff) gist (raw diff) - Please review changes)

Pipeline on Agent Hash: 5c2868b6a757ec5fad65a1a9921d450ebc6f7903 [PR build]

vs-mobiletools-engineering-service2 commented 2 months ago

:rocket: [CI Build] Test results :rocket:

Test results

:white_check_mark: All tests passed on VSTS: test results.

:tada: All 170 tests passed :tada:

Tests counts

:white_check_mark: cecil: All 1 tests passed. Html Report (VSDrops) Download :white_check_mark: dotnettests (iOS): All 1 tests passed. Html Report (VSDrops) Download :white_check_mark: dotnettests (MacCatalyst): All 1 tests passed. Html Report (VSDrops) Download :white_check_mark: dotnettests (macOS): All 1 tests passed. Html Report (VSDrops) Download :white_check_mark: dotnettests (Multiple platforms): All 1 tests passed. Html Report (VSDrops) Download :white_check_mark: dotnettests (tvOS): All 1 tests passed. Html Report (VSDrops) Download :white_check_mark: framework: All 8 tests passed. Html Report (VSDrops) Download :white_check_mark: fsharp: All 7 tests passed. Html Report (VSDrops) Download :white_check_mark: generator: All 2 tests passed. Html Report (VSDrops) Download :white_check_mark: install-source: All 1 tests passed. Html Report (VSDrops) Download :white_check_mark: interdependent-binding-projects: All 7 tests passed. Html Report (VSDrops) Download :white_check_mark: introspection: All 8 tests passed. Html Report (VSDrops) Download :white_check_mark: linker: All 65 tests passed. Html Report (VSDrops) Download :white_check_mark: mac-binding-project: All 1 tests passed. Html Report (VSDrops) Download :white_check_mark: mmp: All 2 tests passed. Html Report (VSDrops) Download :white_check_mark: mononative: All 6 tests passed. Html Report (VSDrops) Download :white_check_mark: monotouch (iOS): All 11 tests passed. Html Report (VSDrops) Download :white_check_mark: monotouch (MacCatalyst): All 7 tests passed. Html Report (VSDrops) Download :white_check_mark: monotouch (macOS): All 8 tests passed. Html Report (VSDrops) Download :white_check_mark: monotouch (tvOS): All 11 tests passed. Html Report (VSDrops) Download :white_check_mark: monotouch (watchOS): All 4 tests passed. Html Report (VSDrops) Download :white_check_mark: msbuild: All 2 tests passed. Html Report (VSDrops) Download :white_check_mark: mtouch: All 1 tests passed. Html Report (VSDrops) Download :white_check_mark: xammac: All 3 tests passed. Html Report (VSDrops) Download :white_check_mark: xcframework: All 8 tests passed. Html Report (VSDrops) Download :white_check_mark: xtro: All 2 tests passed. Html Report (VSDrops) Download

Pipeline on Agent Hash: [PR build]