ApiDocInput (FSharp.Formatting)

ApiDocInput Type

Namespace: FSharp.Formatting.ApiDocs
Assembly: FSharp.Formatting.ApiDocs.dll
Base Type: obj
All Interfaces: IEquatable<ApiDocInput> , IStructuralEquatable , IComparable<ApiDocInput> , IComparable , IStructuralComparable

Represents an input assembly for API doc generation

Record fields

Record Field	Description
`MarkdownComments` Full Usage: `MarkdownComments` Field type: `bool`	Whether the input uses markdown comments Field type: `bool`
`Path` Full Usage: `Path` Field type: `string`	The path to the assembly Field type: `string`
`PublicOnly` Full Usage: `PublicOnly` Field type: `bool`	Whether to generate only public things Field type: `bool`
`ShowInheritedMembers` Full Usage: `ShowInheritedMembers` Field type: `bool`	Whether to show members inherited from documented base types. Defaults to true. Set to false to suppress "Inherited from X" sections. Field type: `bool`
`SourceFolder` Full Usage: `SourceFolder` Field type: `string option`	The compile-time source folder Field type: `string option`
`SourceRepo` Full Usage: `SourceRepo` Field type: `string option`	The URL the the source repo where the source code lives Field type: `string option`
`Substitutions` Full Usage: `Substitutions` Field type: `Substitutions option`	The substitutionss active for this input. If specified these are used instead of the overall substitutions. This allows different parameters (e.g. different authors) for each assembly in a collection. Field type: `Substitutions option`
`TypeConstraintDisplayMode` Full Usage: `TypeConstraintDisplayMode` Field type: `TypeConstraintDisplayMode`	Controls how type constraints on generic members are displayed. Defaults to Short, which appends constraints inline as a 'when' clause. Field type: `TypeConstraintDisplayMode`
`Warn` Full Usage: `Warn` Field type: `bool`	Whether doc processing should warn on missing comments Field type: `bool`
`XmlFile` Full Usage: `XmlFile` Field type: `string option`	Override the default XML file (normally assumed to live alongside) Field type: `string option`

Static members

Static member Description

Static member	Description
`ApiDocInput.FromFile(assemblyPath, ?mdcomments, ?substitutions, ?sourceRepo, ?sourceFolder, ?publicOnly, ?warn, ?showInheritedMembers, ?typeConstraintDisplayMode)` Full Usage: `ApiDocInput.FromFile(assemblyPath, ?mdcomments, ?substitutions, ?sourceRepo, ?sourceFolder, ?publicOnly, ?warn, ?showInheritedMembers, ?typeConstraintDisplayMode)` Parameters: assemblyPath : `string` ?mdcomments : `bool` ?substitutions : `Substitutions` ?sourceRepo : `string` ?sourceFolder : `string` ?publicOnly : `bool` ?warn : `bool` ?showInheritedMembers : `bool` ?typeConstraintDisplayMode : `TypeConstraintDisplayMode` Returns: `ApiDocInput`	assemblyPath : `string` ?mdcomments : `bool` ?substitutions : `Substitutions` ?sourceRepo : `string` ?sourceFolder : `string` ?publicOnly : `bool` ?warn : `bool` ?showInheritedMembers : `bool` ?typeConstraintDisplayMode : `TypeConstraintDisplayMode` Returns: `ApiDocInput`


                
                  
                    
                      ApiDocInput.FromFile(assemblyPath, ?mdcomments, ?substitutions, ?sourceRepo, ?sourceFolder, ?publicOnly, ?warn, ?showInheritedMembers, ?typeConstraintDisplayMode)

Full Usage:

ApiDocInput.FromFile(assemblyPath, ?mdcomments, ?substitutions, ?sourceRepo, ?sourceFolder, ?publicOnly, ?warn, ?showInheritedMembers, ?typeConstraintDisplayMode)

Parameters:

assemblyPath : string

?mdcomments : bool

?substitutions : Substitutions

?sourceRepo : string

?sourceFolder : string

?publicOnly : bool

?warn : bool

?showInheritedMembers : bool

?typeConstraintDisplayMode : TypeConstraintDisplayMode

Returns: ApiDocInput

assemblyPath : string
?mdcomments : bool
?substitutions : Substitutions
?sourceRepo : string
?sourceFolder : string
?publicOnly : bool
?warn : bool
?showInheritedMembers : bool
?typeConstraintDisplayMode : TypeConstraintDisplayMode

Returns: ApiDocInput