Skip to content

Commit 6ac8410

Browse files
authored
chore: Fix filterconfig.yml and enumSortOrder documentation (#9839)
chore: fix filterconfig documents
1 parent 2c20fa6 commit 6ac8410

File tree

2 files changed

+9
-9
lines changed

2 files changed

+9
-9
lines changed

docs/docs/dotnet-api-docs.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -229,12 +229,12 @@ API filter are hierarchical, if a namespace is excluded, all types/members defin
229229
```yaml
230230
apiRules:
231231
- exclude:
232-
hasAttribute:
233-
uid: System.AttributeUsageAttribute
234-
ctorArguments:
235-
- System.AttributeTargets.Class
236-
ctorNamedArguments:
237-
Inherited: "true"
232+
hasAttribute:
233+
uid: System.AttributeUsageAttribute
234+
ctorArguments:
235+
- System.AttributeTargets.Class
236+
ctorNamedArguments:
237+
Inherited: "True"
238238
```
239239

240240
Where the `ctorArguments` property specifies a list of match conditions based on constructor parameters and the `ctorNamedArguments` property specifies match conditions using named constructor arguments.

src/Docfx.Dotnet/MetadataJsonConfig.cs

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -213,9 +213,9 @@ internal class MetadataJsonItemConfig
213213
public MemberLayout MemberLayout { get; set; }
214214

215215
/// <summary>
216-
/// Defines how member pages are organized:
217-
/// - `samePage` (default): Places members in the same page as their containing type.
218-
/// - `separatePages`: Places members in separate pages.
216+
/// Specifies how enum members are sorted:
217+
/// - `alphabetic`(default): Sort enum members in alphabetic order.
218+
/// - `declaringOrder`: Sort enum members in the order as they are declared in the source code.
219219
/// </summary>
220220
[JsonProperty("enumSortOrder")]
221221
[JsonPropertyName("enumSortOrder")]

0 commit comments

Comments
 (0)