Documentation.cs 1.5 KB

1234567891011121314151617181920212223242526272829303132333435363738
  1. using System.Runtime.CompilerServices;
  2. [assembly: InternalsVisibleTo("Unity.RenderPipelines.Core.Editor.Tests")]
  3. namespace UnityEngine.Rendering
  4. {
  5. //We need to have only one version number amongst packages (so public)
  6. /// <summary>
  7. /// Documentation Info class.
  8. /// </summary>
  9. public class DocumentationInfo
  10. {
  11. //Update this field when upgrading the target Documentation for the package
  12. //Should be linked to the package version somehow.
  13. /// <summary>
  14. /// Current version of the documentation.
  15. /// </summary>
  16. public const string version = "10.8";
  17. }
  18. //Need to live in Runtime as Attribute of documentation is on Runtime classes \o/
  19. /// <summary>
  20. /// Documentation class.
  21. /// </summary>
  22. class Documentation : DocumentationInfo
  23. {
  24. //This must be used like
  25. //[HelpURL(Documentation.baseURL + Documentation.version + Documentation.subURL + "some-page" + Documentation.endURL)]
  26. //It cannot support String.Format nor string interpolation
  27. internal const string baseURL = "https://docs.unity3d.com/Packages/com.unity.render-pipelines.core@";
  28. internal const string subURL = "/manual/";
  29. internal const string endURL = ".html";
  30. //Temporary for now, there is several part of the Core documentation that are misplaced in HDRP documentation.
  31. //use this base url for them:
  32. internal const string baseURLHDRP = "https://docs.unity3d.com/Packages/com.unity.render-pipelines.high-definition@";
  33. }
  34. }