Class DocumentationInfo.SourceAttribute
Apply this attribute to a RenderPipelineAsset type to declare where its
user-facing documentation is hosted. Consumed by CurrentPipelineHelpURLAttribute
and PipelineHelpURLAttribute to choose between Unity Manual URLs and
the package documentation site.
Inherited Members
Namespace: UnityEngine.Rendering
Assembly: Unity.RenderPipelines.Core.Runtime.dll
Syntax
[Conditional("UNITY_EDITOR")]
[AttributeUsage(AttributeTargets.Class, AllowMultiple = false, Inherited = false)]
public sealed class DocumentationInfo.SourceAttribute : AttributeRemarks
Editor-only: the attribute is stripped from non-Editor builds via ConditionalAttribute, since the help URL machinery only runs in the Editor.
Examples
[DocumentationInfo.Source(DocumentationInfo.Location.Manual)]
public class UniversalRenderPipelineAsset : RenderPipelineAsset { /* ... */ }Constructors
SourceAttribute(Location)
Creates the attribute with the given documentation location.
Declaration
public SourceAttribute(DocumentationInfo.Location location)Parameters
| Type | Name | Description |
|---|---|---|
| DocumentationInfo.Location | location | Where the pipeline's documentation pages are hosted. |
Properties
Location
The documentation location for the decorated pipeline asset type.
Declaration
public DocumentationInfo.Location Location { get; }Property Value
| Type | Description |
|---|---|
| DocumentationInfo.Location |