Documenting pre-built assemblies

Note

This is an experimental feature. You might find that DocFX can't parse your assembly, or certain namespaces within the assembly. Use the #ask-doc-tools Slack channel for support.

Some packages might contain .NET assemblies that need documentation, but the package owners don't have access to the source. Under these circumstances, you can use DocFX overwrites to add API documentation. The workflow looks like this:

Include the assembly in the script reference

Add or modify the Documentation~/projectMetadata.json file to include the assembly in the script reference. For example:

{
    "includeAssembliesInSrc":[
        "**/Runtime/UDP.dll"
    ]
}

Note that glob syntax is accepted.

Add documentation for the members

Add or modify the Documentation~/apidoc/overwrites.md file to add xmldoc tags to the API members. For example:

---
uid: UnityEngine.UDP.AppInfo
remarks: *content
---
Quick test of **complicated** override system...

Where the format is as follows:

---
uid: <Fully qualified member name>
<xmldoc tag>: *content
---
<markdown content>
---
uid: <Fully qualified member name>

You can define multiple elements in a single document. You can also split content into multiple overwrite files (with unique names) as long as they are all inside:

Documentation~/apidoc

Note that the file has a markdown extension but the content must be in yaml format.