Skip to content

Add default value documentation for Label.LineBreakMode property#33490

Merged
rmarinho merged 2 commits intomainfrom
copilot/update-label-api-docs
Jan 13, 2026
Merged

Add default value documentation for Label.LineBreakMode property#33490
rmarinho merged 2 commits intomainfrom
copilot/update-label-api-docs

Conversation

Copy link
Contributor

Copilot AI commented Jan 13, 2026

The XML API documentation for Label.LineBreakMode was missing the default value, creating inconsistency with the documentation site which now correctly specifies WordWrap as the default.

Changes

  • Added default value documentation to LineBreakMode property in Label.cs
  • Follows existing documentation pattern used for other bindable properties (e.g., Button.CommandParameter, Border.SafeAreaEdges)
/// <summary>
/// Gets or sets the LineBreakMode for the Label.
/// The default value is <see cref="LineBreakMode.WordWrap"/>. This is a bindable property.
/// </summary>
public LineBreakMode LineBreakMode

The default value LineBreakMode.WordWrap is confirmed in the BindableProperty.Create definition at line 104.

Original prompt

For LineBreakMode in src/Controls/src/Core/Label/Label.cs can you specify the default value on the API docs as also indicated here: dotnet/docs-maui#3168


💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.

- Updated XML documentation to indicate LineBreakMode defaults to WordWrap
- Follows established documentation patterns in the codebase
- Build verified successfully with no errors or warnings

Co-authored-by: jfversluis <939291+jfversluis@users.noreply.github.com>
Copilot AI changed the title [WIP] Specify default value for LineBreakMode in API docs Add default value documentation for Label.LineBreakMode property Jan 13, 2026
Copilot AI requested a review from jfversluis January 13, 2026 08:37
@jfversluis jfversluis added the area-docs Conceptual docs, API docs, Samples label Jan 13, 2026
@jfversluis jfversluis marked this pull request as ready for review January 13, 2026 10:03
Copilot AI review requested due to automatic review settings January 13, 2026 10:03
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds default value documentation to the Label.LineBreakMode property to align the XML API documentation with the documentation site, which already specifies WordWrap as the default value.

Changes:

  • Updated the XML documentation comment for the LineBreakMode property to include the default value (LineBreakMode.WordWrap)

@rmarinho rmarinho merged commit 249422f into main Jan 13, 2026
29 of 34 checks passed
@rmarinho rmarinho deleted the copilot/update-label-api-docs branch January 13, 2026 10:56
kubaflo pushed a commit to kubaflo/maui that referenced this pull request Jan 16, 2026
…net#33490)

The XML API documentation for `Label.LineBreakMode` was missing the
default value, creating inconsistency with the [documentation
site](dotnet/docs-maui#3168) which now correctly
specifies `WordWrap` as the default.

### Changes
- Added default value documentation to `LineBreakMode` property in
`Label.cs`
- Follows existing documentation pattern used for other bindable
properties (e.g., `Button.CommandParameter`, `Border.SafeAreaEdges`)

```csharp
/// <summary>
/// Gets or sets the LineBreakMode for the Label.
/// The default value is <see cref="LineBreakMode.WordWrap"/>. This is a bindable property.
/// </summary>
public LineBreakMode LineBreakMode
```

The default value `LineBreakMode.WordWrap` is confirmed in the
`BindableProperty.Create` definition at line 104.

<!-- START COPILOT CODING AGENT SUFFIX -->



<!-- START COPILOT ORIGINAL PROMPT -->



<details>

<summary>Original prompt</summary>

> For LineBreakMode in src/Controls/src/Core/Label/Label.cs can you
specify the default value on the API docs as also indicated here:
dotnet/docs-maui#3168


</details>



<!-- START COPILOT CODING AGENT TIPS -->
---

💡 You can make Copilot smarter by setting up custom instructions,
customizing its development environment and configuring Model Context
Protocol (MCP) servers. Learn more [Copilot coding agent
tips](https://gh.io/copilot-coding-agent-tips) in the docs.

---------

Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com>
Co-authored-by: jfversluis <939291+jfversluis@users.noreply.github.com>
@github-actions github-actions bot locked and limited conversation to collaborators Feb 13, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

area-docs Conceptual docs, API docs, Samples

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants