Linking to Unity API when inheriting from a Unity class (when building API docs from .cs files) #8643
Unanswered
PhantasmicDev
asked this question in
Q&A
Replies: 0 comments
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
-
I'm working on a custom unity package hosted on github where I want to use docfx in a github workflow to generate documentation for it. The github repo looks like this
I don't have access to the .csproj file Unity generates so I can't provide that in the docfx.json metadata src entry. I end up providing the source code like this
This will generate the documentation for my API well but I run into a problem where my script
PlatformPlayerLauncher
inherits from ScriptableObject but in the inheritance tree in the docs it doesn't show that.I provide this xref map in my docfx.json file, but I think it has to do with how docfx gathers the source files. I think there is not enough context with the .cs files alone to determine my script is inheriting from ScriptableObject.
I came to this conclusion because I've built the documentation before using the generated .csproj file Unity generates which has more data on the references my code relies on but again I don't include the whole unity project and if I did, .csproj files are normally ignore for version control.
I'd like to properly show my class' inheritance like Unity does in their doc's PlayerInput entry.
I've also tried providing the UnityEngine.dll and UnityEngine.CoreModule.dll as a reference in my docfx.json file such as this
What options do I have to achieve the desired outcome of properly linking to Unity API when Inheriting from a Unity class?
Beta Was this translation helpful? Give feedback.
All reactions