[docs] Improve XML docs for QLPreviewPanel#25926
Conversation
Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR improves the public XML documentation for the QuickLookUI.QLPreviewPanel convenience methods by replacing placeholder text with meaningful summaries/return descriptions, making the API surface easier to understand when using IntelliSense.
Changes:
- Documented
EnterFullScreenMode()with a concrete summary and boolean return meaning. - Documented
ExitFullScreenModeWithOptions()with a concrete summary. - Removed the prior “To be added.” / empty remarks placeholder docs.
This comment has been minimized.
This comment has been minimized.
✅ [PR Build #c014521] Build passed (Detect API changes) ✅Pipeline on Agent |
✅ [PR Build #c014521] Build passed (Build packages) ✅Pipeline on Agent |
✅ API diff for current PR / commitNET (empty diffs)✅ API diff vs stableNET (empty diffs)ℹ️ Generator diffGenerator Diff: vsdrops (html) vsdrops (raw diff) gist (raw diff) - Please review changes) Pipeline on Agent |
✅ [PR Build #c014521] Build passed (Build macOS tests) ✅Pipeline on Agent |
🔥 [CI Build #c014521] Test results 🔥Test results❌ Tests failed on VSTS: test results 1 tests crashed, 0 tests failed, 196 tests passed. Failures❌ windows tests🔥 Failed catastrophically on VSTS: test results - windows (no summary found). Html Report (VSDrops) Download Successes✅ assembly-processing: All 1 tests passed. Html Report (VSDrops) Download macOS tests✅ Tests on macOS Monterey (12): All 5 tests passed. Html Report (VSDrops) Download Linux Build VerificationPipeline on Agent |
Improve XML documentation for the
QLPreviewPaneltype:<remarks>nodesEnterFullScreenModeandExitFullScreenModeWithOptionsmethods🤖 Pull request created by Copilot