[docs] Improve XML docs for ModelAttribute - #25964
Conversation
Inline the XML docs from the include file and remove the external documentation file. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR updates the Foundation.ModelAttribute API documentation by moving documentation inline into the source file and removing the legacy external XML doc file.
Changes:
- Replaced the
<include ...ModelAttribute.xml />reference with inline<summary>/<remarks>documentation inModelAttribute.cs. - Improved constructor and
Nameproperty XML docs (removing “To be added.” placeholders). - Deleted
docs/api/Foundation/ModelAttribute.xmlsince the docs are now inline.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| src/Foundation/ModelAttribute.cs | Adds inline XML docs for ModelAttribute and its members. |
| docs/api/Foundation/ModelAttribute.xml | Removes the redundant external XML documentation file. |
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
This comment has been minimized.
✅ 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 |
This comment has been minimized.
This comment has been minimized.
🚀 [CI Build #59b4252] Test results 🚀Test results✅ All tests passed on VSTS: test results. 🎉 All 199 tests passed 🎉 Tests counts✅ 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
ModelAttributetype:<remarks>nodesdocs/api/Foundation/ModelAttribute.xml(docs are now inline in source)Nameproperty🤖 Pull request created by Copilot