Class DocumentationInfo

Documentation Info class.

Inheritance
object
DocumentationInfo
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

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.

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.

Extension Methods