Skip to content

Commit

Permalink
adjust readme for #1014 issue (#3233)
Browse files Browse the repository at this point in the history
  • Loading branch information
EvgeniyZ authored Jan 24, 2025
1 parent 0ecfee4 commit d44445a
Showing 1 changed file with 4 additions and 4 deletions.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -565,8 +565,8 @@ To enhance the generated docs with human-friendly descriptions, you can annotate
[ProducesResponseType(500)]
public Product GetById(int id)
```
4. You can also annotate types with summary and example tags:

4. Annotate your types with summary and example tags, other tags (remarks, para, etc.) are not supported:

```csharp
public class Product
Expand All @@ -582,12 +582,12 @@ To enhance the generated docs with human-friendly descriptions, you can annotate
/// </summary>
/// <example>10</example>
public int AvailableStock { get; set; }

/// <summary>
/// The sizes the product is available in
/// </summary>
/// <example>["Small", "Medium", "Large"]</example>
public List<string> Sizes { get; set; }
public List<string> Sizes { get; set; }
}
```

Expand Down

0 comments on commit d44445a

Please sign in to comment.