docs: Add <inheritdoc /> to override members missing XML docs - #345
Conversation
Co-authored-by: damyanpetev <3198469+damyanpetev@users.noreply.github.com>
Co-authored-by: damyanpetev <3198469+damyanpetev@users.noreply.github.com>
There was a problem hiding this comment.
Pull request overview
This PR reduces CS1591 missing-XML-doc warnings across the Ignite UI for Blazor wrapper and infrastructure layers by adding /// <inheritdoc /> to override members that previously had no XML doc comment, delegating the actual documentation text to the base declarations.
Changes:
- Added
/// <inheritdoc />to override members insrc/components/Blazorwrapper components and related event-args/serialization types. - Added
/// <inheritdoc />to override members insrc/componentsBaseshared infrastructure (renderer base types, dynamic content holder, and WebInputs helpers). - No behavioral/API signature changes intended; changes are limited to XML documentation comments.
Reviewed changes
Copilot reviewed 157 out of 157 changed files in this pull request and generated 1 comment.
Show a summary per file
| File | Description |
|---|---|
| src/componentsBase/WebInputs/TreeItem.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/componentsBase/WebInputs/Tree.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/componentsBase/WebInputs/TileManager.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/componentsBase/WebInputs/Tile.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/componentsBase/WebInputs/SelectItem.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/componentsBase/WebInputs/Select.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/componentsBase/WebInputs/Rating.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/componentsBase/WebInputs/Input.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/componentsBase/WebInputs/DropdownItem.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/componentsBase/WebInputs/Dropdown.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/componentsBase/WebInputs/Accordion.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/componentsBase/IgbComponentRendererContainer.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/componentsBase/DynamicContentHolder.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/componentsBase/BaseRendererElement.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/componentsBase/BaseRendererControl.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/componentsBase/BaseCollection.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/VoidEventArgs.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/TreeSelectionEventArgsDetail.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/TreeSelectionEventArgs.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/TreeItemComponentEventArgs.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/TreeItem.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/Tree.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/Tooltip.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/ToggleButton.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/Toast.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/TileManager.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/TileComponentEventArgs.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/TileChangeStateEventArgsDetail.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/TileChangeStateEventArgs.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/Tile.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/ThemeProvider.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/Textarea.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/Tabs.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/TabComponentEventArgs.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/Tab.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/Switch.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/Stepper.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/Step.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/SplitterResizeEventArgsDetail.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/SplitterResizeEventArgs.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/Splitter.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/Snackbar.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/SliderLabel.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/SliderBase.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/Slider.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/SelectItemComponentEventArgs.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/SelectItem.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/SelectHeader.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/SelectGroup.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/Select.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/Ripple.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/RatingSymbol.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/Rating.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/RangeSliderValueEventArgs.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/RangeSliderValue.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/RangeSlider.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/RadioGroup.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/RadioChangeEventArgsDetail.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/RadioChangeEventArgs.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/Radio.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/ProgressBase.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/NumberFormatSpecifier.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/NumberEventArgs.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/NavDrawerItem.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/NavDrawerHeaderItem.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/NavDrawer.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/Navbar.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/MaskInput.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/ListItem.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/ListHeader.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/List.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/LinearProgress.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/InputBase.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/Input.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/IconMeta.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/IconButton.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/Icon.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/HighlightNavigation.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/Highlight.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/FormatSpecifier.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/FocusOptions.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/FilteringOptions.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/ExpansionPanelComponentEventArgs.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/ExpansionPanel.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/DropdownItemComponentEventArgs.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/DropdownItem.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/DropdownHeader.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/DropdownGroup.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/Dropdown.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/Divider.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/Dialog.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/DateTimeInputBase.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/DateTimeInput.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/DateRangeValueEventArgs.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/DateRangeValueDetail.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/DateRangeValue.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/DateRangePickerResourceStrings.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/DateRangePicker.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/DateRangeDescriptor.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/DatePicker.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/DatePartDeltas.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/CustomDateRange.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/ComponentValueChangedEventArgs.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/ComponentDateValueChangedEventArgs.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/ComponentDataValueChangedEventArgs.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/ComponentBoolValueChangedEventArgs.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/ComboChangeEventArgsDetail.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/ComboChangeEventArgs.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/ComboBoxBaseLike.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/Combo.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/CircularProgress.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/CircularGradient.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/Chip.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/CheckboxChangeEventArgsDetail.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/CheckboxChangeEventArgs.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/CheckboxBase.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/Checkbox.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/ChatRenderers.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/ChatRenderContext.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/ChatOptions.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/ChatMessageRenderContext.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/ChatMessageReactionEventArgs.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/ChatMessageReaction.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/ChatMessageEventArgs.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/ChatMessageAttachmentEventArgs.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/ChatMessageAttachment.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/ChatMessage.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/ChatInputRenderContext.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/ChatDraftMessage.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/ChatAttachmentRenderContext.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/Chat.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/CarouselSlide.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/CarouselIndicator.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/Carousel.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/CardMedia.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/CardHeader.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/CardContent.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/CardActions.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/Card.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/CalendarResourceStrings.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/CalendarFormatOptions.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/CalendarBase.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/Calendar.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/ButtonGroup.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/ButtonBase.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/Button.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/BaseOptionLike.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/BaseComboBox.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/BaseAlertLike.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/Banner.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/Badge.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/Avatar.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/ActiveStepChangingEventArgsDetail.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/ActiveStepChangingEventArgs.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/ActiveStepChangedEventArgsDetail.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/ActiveStepChangedEventArgs.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
| src/components/Blazor/Accordion.cs | Add <inheritdoc /> to override member(s) missing XML docs. |
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
| /// <inheritdoc /> | ||
| protected override void BuildRenderTree(RenderTreeBuilder __builder) | ||
| { | ||
| __builder.OpenElement(0, "div"); |
There was a problem hiding this comment.
@copilot instead of keeping var __builder, just rename the param to builder instead;
There was a problem hiding this comment.
Updated in commit 11425f9: BuildRenderTree now uses RenderTreeBuilder builder (renamed from __builder) and all usages in the method were updated accordingly.
Co-authored-by: damyanpetev <3198469+damyanpetev@users.noreply.github.com>
| } | ||
| } | ||
|
|
||
| /// <inheritdoc /> |
There was a problem hiding this comment.
@copilot The internal override doesn't actually produce a warning to begin with and the root member is also unlikely to be garnished in its current iteration, so those are actually not needed.
There should be a direct, verifiable correlation between this projects warnings before and after the docs and the number of lines added in this PR (excluding the last commit)
There was a problem hiding this comment.
Addressed in 9417104: removed /// <inheritdoc /> from the internal override SerializeCore(...) in Dropdown.cs.
There was a problem hiding this comment.
@copilot Not resolved, that was an example, surely there are others such in other files you've added that can also be dropped. Also do report/validate the before/after warnings for the project (not solution) and the doc comments you've added.
Co-authored-by: damyanpetev <3198469+damyanpetev@users.noreply.github.com>
Co-authored-by: damyanpetev <3198469+damyanpetev@users.noreply.github.com>
<inheritdoc /> to override members missing XML docs in components/Blazor and componentsBase<inheritdoc /> to override members missing XML docs
Following up on #286, many
protected override/internal override/public overridemembers across the component wrappers still emit CS1591 missing-XML-comment warnings. Adding/// <inheritdoc />resolves these consistently, deferring documentation gaps to the base class declarations for a separate follow-up.src/components/Blazor/// <inheritdoc />above every override member (properties, methods, fields, events) lacking a doc comment, across 141 files.src/componentsBaseExample:
No behavioral changes — this only adds documentation comments. Members without a base declaration to inherit docs from (e.g. new members, enum values) are unaffected and remain out of scope.