Class DocumentationInfo
Documentation Info class.
Inherited Members
Namespace: UnityEngine .Rendering
Assembly: Unity.RenderPipelines.Core.Runtime.dll
Syntax
public class DocumentationInfo
Properties
version
Current version of the documentation.
Declaration
public static string version { get; }
Property Value
Type | Description |
---|---|
string |
Methods
GetDefaultPackageLink(string)
Generates a help url to the index page for the provided package name and package version.
Declaration
public static string GetDefaultPackageLink(string packageName)
Parameters
Type | Name | Description |
---|---|---|
string | packageName | The name of the package. |
Returns
Type | Description |
---|---|
string | The full URL to the default package documentation page. |
GetDefaultPackageLink(string, string)
Generates a help url to the index page for the provided package name and package version.
Declaration
public static string GetDefaultPackageLink(string packageName, string packageVersion)
Parameters
Type | Name | Description |
---|---|---|
string | packageName | The name of the package. |
string | packageVersion | The version of the package. |
Returns
Type | Description |
---|---|
string | The full URL to the default package documentation page. |
GetPackageLink(string, string, string)
Generates a help URL for the given package and page name.
Declaration
public static string GetPackageLink(string packageName, string packageVersion, string pageName)
Parameters
Type | Name | Description |
---|---|---|
string | packageName | The package name. |
string | packageVersion | The package version. |
string | pageName | The page name without the extension. |
Returns
Type | Description |
---|---|
string | The full URL of the page. |
GetPackageLink(string, string, string, string)
Generates a help URL for the given package, page name and section name.
Declaration
public static string GetPackageLink(string packageName, string packageVersion, string pageName, string pageHash)
Parameters
Type | Name | Description |
---|---|---|
string | packageName | The package name. |
string | packageVersion | The package version. |
string | pageName | The page name without the extension. |
string | pageHash | The section name on the documentation page. |
Returns
Type | Description |
---|---|
string | The full URL of the page. |
GetPageLink(string, string)
Generates a help url for the given package and page name
Declaration
public static string GetPageLink(string packageName, string pageName)
Parameters
Type | Name | Description |
---|---|---|
string | packageName | The package name |
string | pageName | The page name without the extension. |
Returns
Type | Description |
---|---|
string | The full URL of the page. |
GetPageLink(string, string, string)
Generates a help url for the given package and page name
Declaration
public static string GetPageLink(string packageName, string pageName, string pageHash)
Parameters
Type | Name | Description |
---|---|---|
string | packageName | The package name |
string | pageName | The page name without the extension. |
string | pageHash | The page hash |
Returns
Type | Description |
---|---|
string | The full URL of the page. |