SwaggerGenOptionsExtensionsIncludeXmlCommentsFromInheritDocs - метод
Inject human-friendly descriptions for Schemas and it's Parameters based on <inheritdoc/> XML Comments (from summary and remarks).
Пространство имён: Tessa.Web.Unchase.Swashbuckle.ExtensionsСборка: Tessa.Web (в Tessa.Web.dll) Версия: 4.0.5
public static SwaggerGenOptions IncludeXmlCommentsFromInheritDocs(
this SwaggerGenOptions swaggerGenOptions,
bool includeRemarks = false,
params Type[]? excludedTypes
)
<ExtensionAttribute>
Public Shared Function IncludeXmlCommentsFromInheritDocs (
swaggerGenOptions As SwaggerGenOptions,
Optional includeRemarks As Boolean = false,
ParamArray excludedTypes As Type()
) As SwaggerGenOptions
public:
[ExtensionAttribute]
static SwaggerGenOptions^ IncludeXmlCommentsFromInheritDocs(
SwaggerGenOptions^ swaggerGenOptions,
bool includeRemarks = false,
... array<Type^>^ excludedTypes
)
[<ExtensionAttribute>]
static member IncludeXmlCommentsFromInheritDocs :
swaggerGenOptions : SwaggerGenOptions *
?includeRemarks : bool *
excludedTypes : Type[]
(* Defaults:
let _includeRemarks = defaultArg includeRemarks false
*)
-> SwaggerGenOptions
- swaggerGenOptions SwaggerGenOptions
- SwaggerGenOptions.
- includeRemarks Boolean (Optional)
-
Flag to indicate to include remarks from XML comments.
- excludedTypes Type
- Types for which remarks will be excluded.
SwaggerGenOptionsВ Visual Basic и C# этот метод можно вызывать как метод экземпляра для любого объекта типа
SwaggerGenOptions. При вызове метода для экземпляра следует опускать первый параметр. Дополнительные сведения см. в разделе
Методы расширения (Visual Basic) или
Методы расширения (Руководство по программированию в C#).