[src] Ignore CS1573 in certain cases. #21941

rolfbjarne · 2025-01-10T16:51:01Z

CS1573 is raised when some, but not all, parameters in a method have xml
comments.

The generated code can trigger this when an api definition has a method with
documented parameters, and then the generator creates a method with additional
parameters (which won't have xml comments).

CS1573 is raised when some, but not all, parameters in a method have xml comments. The generated code can trigger this when an api definition has a method with documented parameters, and then the generator creates a method with additional parameters (which won't have xml comments).

github-actions · 2025-01-10T16:55:00Z

⚠️ 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-01-13T16:21:11Z

🚀 [CI Build] Test results 🚀

Test results

✅ All tests passed on VSTS: test results.

🎉 All 111 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. [attempt 4] 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. [attempt 2] 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 40 tests passed. Html Report (VSDrops) Download
✅ monotouch (iOS): All 10 tests passed. Html Report (VSDrops) Download
✅ monotouch (MacCatalyst): All 12 tests passed. Html Report (VSDrops) Download
✅ monotouch (macOS): All 9 tests passed. [attempt 2] 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: 6ff27218b5dbd8f319558938b7a531ca822694f9 [PR build]

stephen-hawley · 2025-01-13T20:08:56Z

src/bgen/Generator.cs

@@ -4863,6 +4863,9 @@ void GenerateProtocolTypes (Type type, string class_visibility, string TypeName,
 		var extensionMethods = optionalInstanceMethods.Concat (requiredInstanceMethods.Where (v => IsRequired (v, out var generateExtensionMethod) && generateExtensionMethod));
 		var extensionProperties = optionalInstanceProperties.Concat (requiredInstanceProperties.Where (v => IsRequired (v, out var generateExtensionMethod) && generateExtensionMethod));

+		// disable CS1573, which can happen when the original member in the api definition has xml comments and we copy that xml comment into the generated interface - because we may add parameters to method signatures, and the new parameters won't have an xml comment.
+		print ("#pragma warning disable CS1573"); // Parameter 'This' has no matching param tag in the XML comment for '...' (but other parameters do)


Does it make sense to inject a comment as to why this is being disabled?

I don't think most people look at the code we generate, so probably not worth it.

vs-mobiletools-engineering-service2 · 2025-01-13T21:51:50Z

✅ [CI Build] Build passed (Build packages) ✅

Pipeline on Agent
Hash: 4995633aa6ce31bc2042f7284bf912f211dbf7c6 [PR build]

vs-mobiletools-engineering-service2 · 2025-01-13T22:01:13Z

✅ [CI Build] Build passed (Detect API changes) ✅

Pipeline on Agent
Hash: 4995633aa6ce31bc2042f7284bf912f211dbf7c6 [PR build]

vs-mobiletools-engineering-service2 · 2025-01-13T22:16:27Z

✅ [CI Build] Build passed (Build macOS tests) ✅

Pipeline on Agent
Hash: 4995633aa6ce31bc2042f7284bf912f211dbf7c6 [PR build]

vs-mobiletools-engineering-service2 · 2025-01-13T22:31:25Z

💻 [CI Build] Windows Integration Tests passed 💻

✅ All Windows Integration Tests passed.

Pipeline on Agent
Hash: 4995633aa6ce31bc2042f7284bf912f211dbf7c6 [PR build]

vs-mobiletools-engineering-service2 · 2025-01-13T22:34:05Z

💻 [CI Build] Tests on macOS M1 - Mac Monterey (12) passed 💻

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

Pipeline on Agent
Hash: 4995633aa6ce31bc2042f7284bf912f211dbf7c6 [PR build]

vs-mobiletools-engineering-service2 · 2025-01-13T22:36:45Z

💻 [CI Build] Tests on macOS M1 - Mac Ventura (13) passed 💻

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

Pipeline on Agent
Hash: 4995633aa6ce31bc2042f7284bf912f211dbf7c6 [PR build]

vs-mobiletools-engineering-service2 · 2025-01-13T22:37:07Z

💻 [CI Build] Tests on macOS arm64 - Mac Sequoia (15) passed 💻

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

Pipeline on Agent
Hash: 4995633aa6ce31bc2042f7284bf912f211dbf7c6 [PR build]

vs-mobiletools-engineering-service2 · 2025-01-13T22:40:41Z

✅ 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: 4995633aa6ce31bc2042f7284bf912f211dbf7c6 [PR build]

vs-mobiletools-engineering-service2 · 2025-01-13T22:51:23Z

💻 [CI Build] Tests on macOS X64 - Mac Sonoma (14) passed 💻

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

Pipeline on Agent
Hash: 4995633aa6ce31bc2042f7284bf912f211dbf7c6 [PR build]

rolfbjarne and others added 3 commits January 10, 2025 17:47

Add test

84c225c

Auto-format source code

ac7df93

This comment has been minimized.

Sign in to view

mandel-macaque approved these changes Jan 11, 2025

View reviewed changes

Merge branch 'main' into dev/rolf/bgen-cs1573

6ff2721

This comment has been minimized.

Sign in to view

dalexsoto approved these changes Jan 13, 2025

View reviewed changes

stephen-hawley reviewed Jan 13, 2025

View reviewed changes

rolfbjarne merged commit 4995633 into main Jan 13, 2025
48 checks passed

rolfbjarne deleted the dev/rolf/bgen-cs1573 branch January 13, 2025 20:44

[src] Ignore CS1573 in certain cases. #21941

[src] Ignore CS1573 in certain cases. #21941

Conversation

rolfbjarne commented Jan 10, 2025

github-actions bot commented Jan 10, 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.

vs-mobiletools-engineering-service2 commented Jan 13, 2025

🚀 [CI Build] Test results 🚀

Test results

Tests counts

stephen-hawley Jan 13, 2025

Choose a reason for hiding this comment

rolfbjarne Jan 13, 2025

Choose a reason for hiding this comment

vs-mobiletools-engineering-service2 commented Jan 13, 2025

✅ [CI Build] Build passed (Build packages) ✅

vs-mobiletools-engineering-service2 commented Jan 13, 2025

✅ [CI Build] Build passed (Detect API changes) ✅

vs-mobiletools-engineering-service2 commented Jan 13, 2025

✅ [CI Build] Build passed (Build macOS tests) ✅

vs-mobiletools-engineering-service2 commented Jan 13, 2025

💻 [CI Build] Windows Integration Tests passed 💻

vs-mobiletools-engineering-service2 commented Jan 13, 2025

💻 [CI Build] Tests on macOS M1 - Mac Monterey (12) passed 💻

vs-mobiletools-engineering-service2 commented Jan 13, 2025

💻 [CI Build] Tests on macOS M1 - Mac Ventura (13) passed 💻

vs-mobiletools-engineering-service2 commented Jan 13, 2025

💻 [CI Build] Tests on macOS arm64 - Mac Sequoia (15) passed 💻

vs-mobiletools-engineering-service2 commented Jan 13, 2025

✅ API diff for current PR / commit

❗ API diff vs stable (Breaking changes)

ℹ️ Generator diff

vs-mobiletools-engineering-service2 commented Jan 13, 2025

💻 [CI Build] Tests on macOS X64 - Mac Sonoma (14) passed 💻