Skip to content

Commit 5f99163

Browse files
committed
fix: correct malformed XML comments and cref references
1 parent f258443 commit 5f99163

15 files changed

Lines changed: 22 additions & 24 deletions

.github/workflows/generate-preview-docs.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@ jobs:
8181
- name: Upload artifact
8282
uses: actions/upload-pages-artifact@v3
8383
with:
84-
path: '_site'
84+
path: './docs/_site'
8585

8686
- name: Deploy to GitHub Pages
8787
id: deployment

docs/docfx.json

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,6 @@
4848
"TODO": "alert alert-secondary"
4949
}
5050
},
51-
"xref": [
52-
"../.xrefmap.json"
53-
],
5451
"output": "_site",
5552
"template": [
5653
"default",

src/WebExpress.WebUI/WebControl/ControlResponsive.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ public ControlResponsive(string id = null)
3939
/// </summary>
4040
/// <param name="panel">The panel to add.</param>
4141
/// <param name="breakpoint">
42-
/// The minimum width at which the panel becomes visible. Use < 0 to register as fallback panel.
42+
/// The minimum width at which the panel becomes visible. Use values less than 0 to register as fallback panel.
4343
/// </param>
4444
/// <returns>The current instance for method chaining.</returns>
4545
public IControlResponsive Add(IControlPanel panel, int breakpoint)

src/WebExpress.WebUI/WebControl/ControlSearch.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ public class ControlSearch : Control
4040
/// </summary>
4141
public IControl Footer { get; set; }
4242

43-
// <summary>
43+
/// <summary>
4444
/// Returns or sets a value indicating whether favorited suggestions are enabled.
4545
/// </summary>
4646
public bool EnableFavorited { get; set; }

src/WebExpress.WebUI/WebControl/ControlToolbar.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -108,7 +108,7 @@ public IControlToolbar Add(params IControlToolbarItem[] items)
108108
/// var tool = new ControlToolbar();
109109
/// var item1 = new ControlToolBarItemButton { Text = "Item 1" };
110110
/// var item2 = new ControlToolBarItemButton { Text = "Item 2" };
111-
/// tool.Add(new List<IControlToolbarItem>([ item1, item2 ]));
111+
/// tool.Add(item1, item2);
112112
/// </code>
113113
///
114114
/// This method accepts any item that derives from <see cref="IControlToolbarItem"/>.

src/WebExpress.WebUI/WebControl/IControl.cs

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ public interface IControl : IWebUIElement<IRenderControlContext, IVisualTreeCont
7878
/// </summary>
7979
IEnumerable<string> Classes { get; set; }
8080

81+
/// <summary>
8182
/// Returns or sets the css style.
8283
/// </summary>
8384
IEnumerable<string> Styles { get; set; }

src/WebExpress.WebUI/WebControl/IControlNavigation.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -41,7 +41,7 @@ public interface IControlNavigation : IControl
4141
/// var control = new ControlNavigation();
4242
/// var text1 = new ControlNavigationItemLink { Text = "A" };
4343
/// var text2 = new ControlNavigationItemLink { Text = "B" };
44-
/// control.Add(new List<IControlNavigationItem> { text1, text2 });
44+
/// control.Add(text1, text2);
4545
/// </code>
4646
///
4747
/// This method accepts any items that implement the <see cref="IControlNavigationItem"/> interface.

src/WebExpress.WebUI/WebControl/IControlResponsive.cs

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,11 @@
66
public interface IControlResponsive : IControl
77
{
88
/// <summary>
9-
/// Adds a panel that becomes visible at the specified breakpoint.
9+
/// Adds a panel with a specific breakpoint.
1010
/// </summary>
1111
/// <param name="panel">The panel to add.</param>
1212
/// <param name="breakpoint">
13-
/// The minimum width at which the panel becomes visible. Use < 0 to register as fallback panel.
13+
/// The minimum width at which the panel becomes visible. Use values less than 0 to register as fallback panel.
1414
/// </param>
1515
/// <returns>The current instance for method chaining.</returns>
1616
IControlResponsive Add(IControlPanel panel, int breakpoint);

src/WebExpress.WebUI/WebControl/IControlToolbar.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ public interface IControlToolbar : IControl
5656
/// var tool = new ControlToolbar();
5757
/// var item1 = new ControlToolBarItemButton { Text = "Item 1" };
5858
/// var item2 = new ControlToolBarItemButton { Text = "Item 2" };
59-
/// tool.Add(new List<IControlToolbarItem> { item1, item2 });
59+
/// tool.Add(item1, item2);
6060
/// </code>
6161
///
6262
/// This method accepts any item that derives from <see cref="IControlToolbarItem"/>.

src/WebExpress.WebUI/WebControl/IControlUpload.cs

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ public interface IControlUpload : IControl
1818
/// </summary>
1919
IUri Uri { get; }
2020

21-
// <summary>
21+
/// <summary>
2222
/// Returns a value indicating whether multiple selections are allowed.
2323
/// </summary>
2424
bool Multiple { get; }

0 commit comments

Comments
 (0)