FSharp.Formatting


MetadataFormat

Namespace: FSharp.MetadataFormat

This type exposes the functionality for producing documentation from dll files with associated xml files generated by the F# or C# compiler. To generate documentation, use one of the overloades of the Generate method. The overloads have the following optional parameters:

  • outDir - specifies the output directory where documentation should be placed
  • layoutRoots - a list of paths where Razor templates can be found
  • parameters - provides additional parameters to the Razor templates
  • xmlFile - can be used to override the default name of the XML file (by default, we assume the file has the same name as the DLL)
  • markDownComments - specifies if you want to use the Markdown parser for in-code comments. With markDownComments enabled there is no support for <see cref=""> links, so false is recommended for C# assemblies (if not specified, true is used).
  • typeTemplate - the templates to be used for normal types (and C# types) (if not specified, "type.cshtml" is used).
  • moduleTemplate - the templates to be used for modules (if not specified, "module.cshtml" is used).
  • namespaceTemplate - the templates to be used for namespaces (if not specified, "namespaces.cshtml" is used).
  • assemblyReferences - The assemblies to use when compiling Razor templates. Use this parameter if templates fail to compile with mcs on Linux or Mac or if you need additional references in your templates (if not specified, we use the currently loaded assemblies).
  • sourceFolder and sourceRepo - When specified, the documentation generator automatically generates links to GitHub pages for each of the entity.
  • publicOnly - When set to false, the tool will also generate documentation for non-public members
  • libDirs - Use this to specify additional paths where referenced DLL files can be found
  • otherFlags - Additional flags that are passed to the F# compiler (you can use this if you want to specify references explicitly etc.)
  • urlRangeHighlight - A function that can be used to override the default way of generating GitHub links

Static members

Static memberDescription
Generate(...)
Signature: (dllFiles:seq<string> * outDir:string * layoutRoots:string list * parameters:(string * string) list option * namespaceTemplate:string option * moduleTemplate:string option * typeTemplate:string option * xmlFile:string option * sourceRepo:string option * sourceFolder:string option * publicOnly:bool option * libDirs:string list option * otherFlags:string list option * markDownComments:bool option * urlRangeHighlight:(Uri -> int -> int -> string) option * assemblyReferences:string list option) -> unit

This overload generates documentation for multiple files specified by the dllFiles parameter

Generate(...)
Signature: (dllFiles:string list * outDir:string * layoutRoots:string list * parameters:(string * string) list option * namespaceTemplate:string option * moduleTemplate:string option * typeTemplate:string option * xmlFile:string option * sourceRepo:string option * sourceFolder:string option * publicOnly:bool option * libDirs:string list option * otherFlags:string list option * markDownComments:bool option * urlRangeHighlight:(Uri -> int -> int -> string) option * assemblyReferences:string list option) -> unit

generates documentation for multiple files specified by the dllFiles parameter

Generate(...)
Signature: (dllFile:string * outDir:string * layoutRoots:string list * parameters:(string * string) list option * namespaceTemplate:string option * moduleTemplate:string option * typeTemplate:string option * xmlFile:string option * sourceRepo:string option * sourceFolder:string option * publicOnly:bool option * libDirs:string list option * otherFlags:string list option * markDownComments:bool option * urlRangeHighlight:(Uri -> int -> int -> string) option * assemblyReferences:string list option) -> unit

This overload generates documentation for a single file specified by the dllFile parameter

Fork me on GitHub