Class Documentation
Example usage Documentation.Instance.Generate("com.unity.ads", "2.0.3"); Documentation.Instance.GenerateRedirect("com.unity.ads", "2.0.3");
Inherited Members
Namespace: UnityEditor.PackageManager.DocumentationTools.UI
Assembly: Unity.PackageManagerDocTools.Editor.dll
Syntax
public class DocumentationProperties
| Name | Description |
|---|---|
| Instance |
Methods
| Name | Description |
|---|---|
| Generate(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 |
| 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 |
| GenerateMetadata(string, string) | Generate metadata for a package. |
| GenerateOffline(PackageInfo, string, string) | Generate a static documentation site suitable for offline viewing. 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 |
| GenerateRedirect(string, string, string, string) | Generate the a site which will redirect to the latest version for a 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 |
| ServeDocs(PackageInfo, string, bool, string, bool) |