Search Unity

Feedback XML Documentation for Unity.Entities (and other) + workaround

Discussion in 'Entity Component System' started by OndrejP, May 19, 2019.

  1. OndrejP

    OndrejP

    Joined:
    Jul 19, 2017
    Posts:
    304
    Why is there no XML documentation for packages by default?
    How to fix it (kinda).

    Turning this:
    upload_2019-5-19_12-21-17.png

    into this:
    upload_2019-5-19_12-25-44.png

    1) Go to:
    Library\PackageCache\com.unity.entities@0.0.12-preview.32\Unity.Entities\

    2) Create new file:
    csc.rsp

    3) Paste this:
    -doc:Library\ScriptAssemblies\Unity.Entities.xml -nowarn:1570 -nowarn:1591 -nowarn:1584 -nowarn:1658 -nowarn:419 -nowarn:1574 -nowarn:1572 -nowarn:1573 -nowarn:1587

    Let Unity recompile the package, switch to Visual Studio and enjoy the documentation.
    - long nowarn list ignores warnings about missing/broken XML comments in packages
    Ofc, downside of this solution is that you have to do it manually for every asmfile in every package. And again when you upgrade any package.

    Dear Unity Team, could we please get this for all packages by default?
    It's great help when you don't need to constantly switch between VS and online docs (and searching).

    Meanwhile, I'll try to write script which would do this automatically for every asmfile in every package.

    EDIT:
    When project script changes and Unity recompiles scripts, XML doc files get deleted.
    Unless there's workaround, it will be completely useless until Unity does it properly.
     

    Attached Files:

    Last edited: May 19, 2019
    eudendeew, Occuros, kdubnz and 3 others like this.