Method GenerateEx
GenerateEx(PackageInfo, string, string)
Generate the documentation for a single package.
By default, the documentation folders will be generated in /Users/USER_NAME/Library/Application Support/Unity/Editor/documentation/packages on Mac C:\Users\USER_NAME\AppData\Local\Unity\Editor\documentation\packages on Windows
Declaration
public (string buildLog, string folderName) GenerateEx(PackageInfo packageInfo, string version, string outputFolder = null)Parameters
| Type | Name | Description |
|---|---|---|
| PackageInfo | packageInfo | The package info object |
| string | version | Version in Semantic version format -- eg: 1.2.0 |
| string | outputFolder | (Optional) Output folder where the doc site should be created. |
Returns
| Type | Description |
|---|---|
| (string buildLog, string folderName) | A tuple of build log string and folder name that contains the result documentation. |