SwaggerGenOptionsExtensionsIncludeXmlCommentsWithRemarks(SwaggerGenOptions, FuncXPathDocument, Boolean, FuncType) - метод
Inject human-friendly descriptions for Operations, Parameters and Schemas based on XML Comment files (from summary and remarks).
Пространство имён: Tessa.Web.Unchase.Swashbuckle.ExtensionsСборка: Tessa.Web (в Tessa.Web.dll) Версия: 4.0.5
public static SwaggerGenOptions IncludeXmlCommentsWithRemarks(
this SwaggerGenOptions swaggerGenOptions,
Func<XPathDocument> xmlDocFactory,
bool includeControllerXmlComments = false,
Func<Type[]>? excludedTypesFunc = null
)
<ExtensionAttribute>
Public Shared Function IncludeXmlCommentsWithRemarks (
swaggerGenOptions As SwaggerGenOptions,
xmlDocFactory As Func(Of XPathDocument),
Optional includeControllerXmlComments As Boolean = false,
Optional excludedTypesFunc As Func(Of Type()) = Nothing
) As SwaggerGenOptions
public:
[ExtensionAttribute]
static SwaggerGenOptions^ IncludeXmlCommentsWithRemarks(
SwaggerGenOptions^ swaggerGenOptions,
Func<XPathDocument^>^ xmlDocFactory,
bool includeControllerXmlComments = false,
Func<array<Type^>^>^ excludedTypesFunc = nullptr
)
[<ExtensionAttribute>]
static member IncludeXmlCommentsWithRemarks :
swaggerGenOptions : SwaggerGenOptions *
xmlDocFactory : Func<XPathDocument> *
?includeControllerXmlComments : bool *
?excludedTypesFunc : Func<Type[]>
(* Defaults:
let _includeControllerXmlComments = defaultArg includeControllerXmlComments false
let _excludedTypesFunc = defaultArg excludedTypesFunc null
*)
-> SwaggerGenOptions
- swaggerGenOptions SwaggerGenOptions
- SwaggerGenOptions.
- xmlDocFactory FuncXPathDocument
- A factory method that returns XML Comments as an XPathDocument.
- includeControllerXmlComments Boolean (Optional)
-
Flag to indicate if controller XML comments (i.e. summary) should be used to assign Tag descriptions.
Don't set this flag if you're customizing the default tag for operations via TagActionsBy.
- excludedTypesFunc FuncType (Optional)
- Func for excluding types.
SwaggerGenOptionsВ Visual Basic и C# этот метод можно вызывать как метод экземпляра для любого объекта типа
SwaggerGenOptions. При вызове метода для экземпляра следует опускать первый параметр. Дополнительные сведения см. в разделе
Методы расширения (Visual Basic) или
Методы расширения (Руководство по программированию в C#).