docs.unity3d.com
Search Results for

    Show / Hide Table of Contents

    Class Documentation

    Need to live in Runtime as Attribute of documentation is on Runtime classes \o/

    Inheritance
    object
    Documentation
    Inherited Members
    object.ToString()
    object.Equals(object)
    object.Equals(object, object)
    object.ReferenceEquals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    Namespace: Mechatronics.SystemGraph
    Assembly: solution.dll
    Syntax
    public static class Documentation

    Fields

    Name Description
    baseURL

    This must be used like [HelpURL(Documentation.baseURL + Documentation.version + Documentation.subURL + "some-page" + Documentation.endURL)] or [HelpURL(Documentation.baseURL + Documentation.version + Documentation.subURL + "some-guide/some-page" + Documentation.endURL)] It cannot support String.Format nor string interpolation

    endURL

    Url file extension

    subURL

    Url folder path

    version

    Update this field when upgrading the target Documentation for the package Should be linked to the package version somehow.

    In This Article
    Back to top
    Copyright © 2024 Unity Technologies — Trademarks and terms of use
    • Legal
    • Privacy Policy
    • Cookie Policy
    • Do Not Sell or Share My Personal Information
    • Your Privacy Choices (Cookie Settings)