Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: Fix filterconfig.yml and enumSortOrder documentation #9839

Merged
merged 1 commit into from
Apr 7, 2024
Merged

chore: Fix filterconfig.yml and enumSortOrder documentation #9839

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 6 additions & 6 deletions docs/docs/dotnet-api-docs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -229,12 +229,12 @@ API filter are hierarchical, if a namespace is excluded, all types/members defin
```yaml
apiRules:
- exclude:
hasAttribute:
uid: System.AttributeUsageAttribute
ctorArguments:
- System.AttributeTargets.Class
ctorNamedArguments:
Inherited: "true"
hasAttribute:
uid: System.AttributeUsageAttribute
ctorArguments:
- System.AttributeTargets.Class
ctorNamedArguments:
Inherited: "True"
```

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.
Expand Down
6 changes: 3 additions & 3 deletions src/Docfx.Dotnet/MetadataJsonConfig.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -213,9 +213,9 @@ internal class MetadataJsonItemConfig
public MemberLayout MemberLayout { get; set; }

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