Search Unity

Documentation Generation - Unity XRefMaps?

Discussion in 'Package Manager' started by ExodusOTH, Apr 23, 2022.

  1. ExodusOTH

    ExodusOTH

    Joined:
    Nov 30, 2017
    Posts:
    45
    Does anybody have XRefMaps that could be used when generating documentation using DocFx?

    I know Unity uses DocFx, back in the day they allowed us to leverage their internal tool, but that public availability has since been removed.

    Another Unity developer has provided an XRefMap.yml file for at least the base Unity classes, however this was last updated over a year ago, and does not include any of Unity's new packages (such as Entities or the Hybrid Renderer).

    Ideally, if someone from Unity sees this, even if you no longer expose your entire internal tool (which would be very nice), is there any way you could provide a documentation site that hosts your various XRefMaps for all your Unity Packages? Currently when generating documentation, any reference to Unity code that exists in a package (and not a part of the UnityEngine by default) just gets ignored by DocFx because it doesn't know where it maps to.

    Alternatively, has anybody out there tried to manually create their own XRefMaps for official Unity Packages?
     
    michaeltlombardi likes this.