[src] Import xml docs for members, part 1. #22210

rolfbjarne · 2025-02-18T17:57:40Z

This has to be done in parts, because the Roslyn importer runs out of memory otherwise.

Which also means I have no idea how many parts there will end up being.

Partial fix for #17399.

This has to be done in parts, because the Roslyn importer runs out of memory otherwise. Which also means I have no idea how many parts there will end up being.

github-actions · 2025-02-18T18:02:05Z

⚠️ Your code has been reformatted. ⚠️

If this is not desired, add the actions-disable-autoformat label, and revert the reformatting commit.

If files unrelated to your change were modified, try reverting the reformatting commit + merging with the target branch (and push those changes).

vs-mobiletools-engineering-service2 · 2025-02-19T11:39:23Z

❌ [CI Build] Windows Integration Tests failed ❌

❌ Failed ❌

Pipeline on Agent
Hash: b9b1099e3b034f78ccc9612da4594cc66c3808e6 [PR build]

vs-mobiletools-engineering-service2 · 2025-02-20T12:24:41Z

✅ [PR Build #38db4b3] Build passed (Build packages) ✅

Pipeline on Agent
Hash: 38db4b301a21a244ccb97507d88fad2718b4d048 [PR build]

vs-mobiletools-engineering-service2 · 2025-02-20T12:26:45Z

✅ [PR Build #38db4b3] Build passed (Detect API changes) ✅

Pipeline on Agent
Hash: 38db4b301a21a244ccb97507d88fad2718b4d048 [PR build]

vs-mobiletools-engineering-service2 · 2025-02-20T12:33:59Z

✅ [PR Build #38db4b3] Build passed (Build macOS tests) ✅

Pipeline on Agent
Hash: 38db4b301a21a244ccb97507d88fad2718b4d048 [PR build]

vs-mobiletools-engineering-service2 · 2025-02-20T12:44:56Z

💻 [PR Build #38db4b3] Tests on macOS M1 - Mac Monterey (12) passed 💻

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

Pipeline on Agent
Hash: 38db4b301a21a244ccb97507d88fad2718b4d048 [PR build]

vs-mobiletools-engineering-service2 · 2025-02-20T12:46:55Z

💻 [PR Build #38db4b3] Tests on macOS M1 - Mac Ventura (13) passed 💻

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

Pipeline on Agent
Hash: 38db4b301a21a244ccb97507d88fad2718b4d048 [PR build]

vs-mobiletools-engineering-service2 · 2025-02-20T12:46:57Z

💻 [PR Build #38db4b3] Tests on macOS arm64 - Mac Sequoia (15) passed 💻

✅ All tests on macOS arm64 - Mac Sequoia (15) passed.

Pipeline on Agent
Hash: 38db4b301a21a244ccb97507d88fad2718b4d048 [PR build]

vs-mobiletools-engineering-service2 · 2025-02-20T12:47:08Z

💻 [PR Build #38db4b3] Tests on macOS X64 - Mac Sonoma (14) passed 💻

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

Pipeline on Agent
Hash: 38db4b301a21a244ccb97507d88fad2718b4d048 [PR build]

vs-mobiletools-engineering-service2 · 2025-02-20T12:58:28Z

✅ API diff for current PR / commit

.NET ( No breaking changes )

iOS: vsdrops gist ( No breaking changes )
tvOS: vsdrops gist ( No breaking changes )
MacCatalyst: vsdrops gist ( No breaking changes )
macOS: vsdrops gist ( No breaking changes )

❗ API diff vs stable (Breaking changes)

.NET ( ❗ Breaking changes ❗ )

iOS: vsdrops gist ( ❗ Breaking changes ❗ )
tvOS: vsdrops gist ( ❗ Breaking changes ❗ )
MacCatalyst: vsdrops gist ( ❗ Breaking changes ❗ )
macOS: vsdrops gist ( ❗ Breaking changes ❗ )

ℹ️ Generator diff

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

Pipeline on Agent
Hash: 38db4b301a21a244ccb97507d88fad2718b4d048 [PR build]

vs-mobiletools-engineering-service2 · 2025-02-20T15:01:54Z

🚀 [CI Build #38db4b3] Test results 🚀

Test results

✅ All tests passed on VSTS: test results.

🎉 All 112 tests passed 🎉

Tests counts

✅ cecil: All 1 tests passed. Html Report (VSDrops) Download
✅ dotnettests (iOS): All 1 tests passed. Html Report (VSDrops) Download
✅ dotnettests (MacCatalyst): All 1 tests passed. Html Report (VSDrops) Download
✅ dotnettests (macOS): All 1 tests passed. Html Report (VSDrops) Download
✅ dotnettests (Multiple platforms): All 1 tests passed. Html Report (VSDrops) Download
✅ dotnettests (tvOS): All 1 tests passed. Html Report (VSDrops) Download
✅ framework: All 2 tests passed. Html Report (VSDrops) Download
✅ fsharp: All 4 tests passed. Html Report (VSDrops) Download
✅ generator: All 5 tests passed. Html Report (VSDrops) Download
✅ interdependent-binding-projects: All 4 tests passed. Html Report (VSDrops) Download
✅ introspection: All 4 tests passed. Html Report (VSDrops) Download
✅ linker: All 44 tests passed. Html Report (VSDrops) Download
✅ monotouch (iOS): All 8 tests passed. Html Report (VSDrops) Download
✅ monotouch (MacCatalyst): All 11 tests passed. Html Report (VSDrops) Download
✅ monotouch (macOS): All 9 tests passed. Html Report (VSDrops) Download
✅ monotouch (tvOS): All 8 tests passed. Html Report (VSDrops) Download
✅ msbuild: All 2 tests passed. Html Report (VSDrops) Download
✅ xcframework: All 4 tests passed. Html Report (VSDrops) Download
✅ xtro: All 1 tests passed. Html Report (VSDrops) Download

Pipeline on Agent
Hash: 38db4b301a21a244ccb97507d88fad2718b4d048 [PR build]

MartyIX · 2025-02-21T11:53:11Z

src/AudioToolbox/AudioFileStream.cs

+		///         <value>
+		///         </value>


Is there any value in having this <value>? :)

This is ported from an existing repository with the documentation, and this is how it was there.

Going through everything to make sure it makes sense is out of scope for this work, so I'm leaving everything as-is.

MartyIX · 2025-02-21T11:53:28Z

src/AudioToolbox/AudioFileStream.cs

@@ -226,6 +277,8 @@ protected virtual void OnPacketDecoded (int numberOfBytes, IntPtr inputData, Aud
 				p (this, new PacketReceivedEventArgs (numberOfBytes, inputData, packetDescriptions));
 		}

+		/// <summary>This event is raised when a property has been found on the decoded data.</summary>
+		///         <remarks>The most interesting property that is raised is AudioFileStreamProperty.ReadyToProducePackets;   When this property is parsed there is enough information to create the output queue.   The MagicCookie and the StreamBasicDescription contain the information necessary to create a working instance of the OutputAudioQueue.</remarks>


Is the indentation correct here?

No, it's off, but I left it as-is for a few reasons:

Turns out it's not entirely trivial to reformat xml and get a result I'm happy with.

I'm using a custom written tool to port the documentation (i.e. create this PR), and it's already more complex than I ever wanted. Pretty printing xml too is out of scope.

This can be fixed later on in an automated fashion (by creating a Roslyn code fixer) if we decide it's important enough.

It doesn't affect the resulting documentation.

I just had in mind a regex converting

/// <remarks>

to

/// <remarks>

But it's just an idea.

I'm happy to see the comments in the codebase (in any form).

Yeah, I don't trust regexes when there are multi-line CDATA section in here with significant whitespace (as I found out because I tried something similar).

Copilot reviewed 161 out of 161 changed files in this pull request and generated no comments.

Comments suppressed due to low confidence (1)

src/AudioUnit/AUEnums.cs:1253

[nitpick] The enum value 'AUiPodTimeOther' mixes casing that may be confusing. Consider renaming it to follow a consistent naming convention (for example, 'IPodTimeOther' or similar) to improve clarity.

AUiPodTimeOther = 0x6970746F, // 'ipto'

rolfbjarne and others added 2 commits February 18, 2025 18:56

[src] Import xml docs for members, part 1.

010aa44

This has to be done in parts, because the Roslyn importer runs out of memory otherwise. Which also means I have no idea how many parts there will end up being.

Auto-format source code

6d42da0

This comment has been minimized.

Sign in to view

rolfbjarne added 2 commits February 19, 2025 08:33

Update cecil

153b7e5

[tests] Fix computing docId for properties with '.' in their name.

b9b1099

rolfbjarne marked this pull request as ready for review February 19, 2025 07:48

rolfbjarne requested review from dalexsoto and mandel-macaque as code owners February 19, 2025 07:48

This comment has been minimized.

Sign in to view

Merge branch 'main' into dev/rolf/xml-docs-1

38db4b3

dalexsoto approved these changes Feb 20, 2025

View reviewed changes

MartyIX reviewed Feb 21, 2025

View reviewed changes

rolfbjarne requested a review from Copilot February 21, 2025 15:44

Copilot AI reviewed Feb 21, 2025

View reviewed changes

[src] Import xml docs for members, part 1. #22210

Are you sure you want to change the base?

[src] Import xml docs for members, part 1. #22210

Conversation

rolfbjarne commented Feb 18, 2025 • edited Loading

github-actions bot commented Feb 18, 2025

⚠️ Your code has been reformatted. ⚠️

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

This comment has been minimized.

vs-mobiletools-engineering-service2 commented Feb 19, 2025

❌ [CI Build] Windows Integration Tests failed ❌

vs-mobiletools-engineering-service2 commented Feb 20, 2025

✅ [PR Build #38db4b3] Build passed (Build packages) ✅

vs-mobiletools-engineering-service2 commented Feb 20, 2025

✅ [PR Build #38db4b3] Build passed (Detect API changes) ✅

vs-mobiletools-engineering-service2 commented Feb 20, 2025

✅ [PR Build #38db4b3] Build passed (Build macOS tests) ✅

vs-mobiletools-engineering-service2 commented Feb 20, 2025

💻 [PR Build #38db4b3] Tests on macOS M1 - Mac Monterey (12) passed 💻

vs-mobiletools-engineering-service2 commented Feb 20, 2025

💻 [PR Build #38db4b3] Tests on macOS M1 - Mac Ventura (13) passed 💻

vs-mobiletools-engineering-service2 commented Feb 20, 2025

💻 [PR Build #38db4b3] Tests on macOS arm64 - Mac Sequoia (15) passed 💻

vs-mobiletools-engineering-service2 commented Feb 20, 2025

💻 [PR Build #38db4b3] Tests on macOS X64 - Mac Sonoma (14) passed 💻

vs-mobiletools-engineering-service2 commented Feb 20, 2025

✅ API diff for current PR / commit

❗ API diff vs stable (Breaking changes)

ℹ️ Generator diff

vs-mobiletools-engineering-service2 commented Feb 20, 2025

🚀 [CI Build #38db4b3] Test results 🚀

Test results

Tests counts

MartyIX Feb 21, 2025

Choose a reason for hiding this comment

rolfbjarne Feb 21, 2025

Choose a reason for hiding this comment

MartyIX Feb 21, 2025

Choose a reason for hiding this comment

rolfbjarne Feb 21, 2025

Choose a reason for hiding this comment

MartyIX Feb 21, 2025 • edited Loading

Choose a reason for hiding this comment

rolfbjarne Feb 21, 2025

Choose a reason for hiding this comment

Choose a reason for hiding this comment

rolfbjarne commented Feb 18, 2025 •

edited

Loading

MartyIX Feb 21, 2025 •

edited

Loading