Search Unity

  1. Unity 6 Preview is now available. To find out what's new, have a look at our Unity 6 Preview blog post.
    Dismiss Notice
  2. Unity is excited to announce that we will be collaborating with TheXPlace for a summer game jam from June 13 - June 19. Learn more.
    Dismiss Notice
  3. Dismiss Notice

Generate XML documentation when using VSTU

Discussion in 'Code Editors & IDEs' started by patrik-org, Apr 19, 2016.

  1. patrik-org

    patrik-org

    Joined:
    Sep 10, 2012
    Posts:
    100
    Seems like VSTU blocks the project settings window in visual studio community 2015. It took me a good while to figure this out since it gives me no message that the window was blocked - it just refuses to open (not very user friendly).

    So my problem is that I want to generate XML docs for my project and since the project property window is blocked from opening there is no way for me to do this.

    How do I work around this?
     
    ModLunar likes this.
  2. patrik-org

    patrik-org

    Joined:
    Sep 10, 2012
    Posts:
    100
    I found a workaround by manually editing the .csproj file and adding the following:
     
  3. Icecubez

    Icecubez

    Joined:
    Apr 18, 2018
    Posts:
    4
    Wait, which .csproj
    And how do you build it after adding in that line?
     
  4. ModLunar

    ModLunar

    Joined:
    Oct 16, 2016
    Posts:
    374
    My project has many csproj files, 1 per .asmdef in my Unity project,
    So you can add this to any or all of your csproj files!

    I found out that Unity's csproj files DON'T seem to support <GenerateDocumentationFile>true</GenerateDocumentationFile>, but DO support the solution presented above!

    I just put it in the first PropertyGroup like this near the top of the file:
    upload_2023-3-3_8-17-28.png

    (You only need to add something like Line 6 from my screenshot -- and feel free to put any file path you'd like there, relative to your Unity project folder)
     
    Last edited: Mar 3, 2023
    Anthiese likes this.