Unity Automatic Documentation Generation (An Editor Plugin)

24 Comments
  1. Daniele
    May 29, 2012

    Jacob I just discovered your blog (while looking for ways to integrate Sublime Text and Unity) and your topics are incredibly fascinating. I hope you’ll get back to write more, though in the meantime I have all your “old” stuff to read.

    You got all my admiration 🙂

    Daniele

    • Daniele
      May 29, 2012

      P.S. and I forgot to mention that this Doxygen plugin is awesome.

  2. michael
    August 7, 2012

    Is there any easy way to move all of the package assets into a subfolder and have it still work? (I like put external stuff in a Plugins folder)

  3. Jos
    September 4, 2012

    Hi Jacob,

    Thanks for this amazing plugin, it works great! I have one question though: The generated documentation is not including all of my classes, particularly, the ones that I have in nested folders. I’ve checked the doxygen config file and the RECURSIVE tag is set to YES. I used the same config file directly on doxygen (with the wizard and also using the console) and I’m still only getting documentation for the files that are directly on my root folder, but not the ones on nested folders. Do you have any idea why this could happen?

    Thanks in advance.

  4. Gavalakis Vaggelis
    April 3, 2013

    Hi. Your plugin looks great.
    You mentioned in the Unity Answers that it can be used with UnityScript if I set the configuration files somehow. I really cant understand what is that I have to set. :/

    Can you please guide me to the right path a bit?

    Thanks a lot again!

  5. Scott Duensing
    July 16, 2013

    Thanks! This is very helpful and quite nice. One thing, it’s mad about running on a Mac.

    Change line 351 from:

    StreamWriter NewDoxyfile = new StreamWriter(config.DocDirectory + @”\Doxyfile”);

    To:

    StreamWriter NewDoxyfile = new StreamWriter(config.DocDirectory + Path.DirectorySeparatorChar + @”Doxyfile”);

  6. Rod Haxton
    October 16, 2013

    Hello Jacob,

    I found your plugin and used it. THANKS!!! I love it! Very easy and simple to use. I love developers that make other developers job easy. Of course to do it, some difficult steps and hard work is usually required but, just wanted to say I greatly appreciate it.

    -Rod

  7. Anyw
    March 10, 2014

    do you a version for javascript?

    • Rodrigo
      November 24, 2015

      Man really, I deeply recomend you learning C#, forget js for unity. Do you see the guys from unity learning session using js for the videos?
      if you want man, i can teach you the basics then you start walking by your own.

  8. SungMin Lee
    April 3, 2014

    Thanks,

    Plugin you have made is great. 
    It helped me a lot. 

    I have one request.
    Will it be possible to adjust and redistribute your plugin for localizing purpose?

  9. Ronin
    April 7, 2014

    I’m on a mac, still not working over here. I saw that you said you had fixed that problem on some forum but its still the same. Where do I find the fixed version for mac.

  10. Carlos González
    March 18, 2015

    I’m working with Unity 5 and C# and this plugin is extremely good for maintainnig the software quality of my project! Thank you so much! 😀

    Your other plugins (like the vector based gestures) seems very interesting also! Keep up the good work! 😀

  11. Michele Mantovan
    December 9, 2015

    Thanks a lot for this plugin! I’m going to testing it on unity 5.3. Now i’m gonna take a look at the other stuff in this great blog.

  12. Isaiah Mann
    December 25, 2015

    Hi Jacob, very interested in this plugin, however, I’m unable to run the “Save Configuration and Build new DoxyFile” function without error.

    The errors I get are:
    “Doxygen finsished with Error: return code 1”

    “IOException: Failed to Copy File / Directory from”

    I’m running Unity 5.3.1f1 on Mac OSX 10.10.5

    Thanks for your consideration.

  13. Martin François
    May 1, 2016

    great work ! thanks a lot

  14. Nicolas
    June 2, 2016

    Awesome plugin, is it possible to export the documentation to a pdf file ?

  15. Clément
    August 1, 2016

    Thanks for this awesome package, it’s really usefull.
    It could be nice to add a checkbox in the setting to choose if we want or not the Private members in the Class.

    For thoses who would like to do that, you need to open DoxyFile and Copy/Paste:
    EXTRACT_PRIVATE = YES

    PS : You need to reput that option if you are changing the theme of your DOxygen Doc.

    Best Regard Clément

  16. […] with a Unity plugin that configures it for you. There’s two Unity plugins, DoxyTool  and DoxygenForUnity, that will help you generate Doxygen from within a Unity […]

    [WORDPRESS HASHCASH] The comment’s server IP (192.0.118.9) doesn’t match the comment’s URL host IP (192.0.78.12) and so is spam.

  17. lUAN nGUYEN
    September 5, 2016

    Hi jacob

    jUST A QUICK QUESTION. i’M TRYING OUT YOUR DOXYGEN PLUGIN FOR UNITY HOWEVER I AM HAVING SOME TROUBLE GENERATING DOCUMENTATION FOR cOROUTINES…COMMENTING BEFORE AN IENUMERATOR DOES NOT SHOW UP IN THE DOC.

    cHEERS

  18. CESARPACHON
    September 12, 2016

    COOL! UNFORTUNATELY iT DOESN’T RUN IN THE LINUX VERSION OF UNITY3D EDITOR.. TESTING WITH VERSION 5.4.0P1

  19. bigo may
    November 29, 2016

    Great plugin to generate documentation for unity projects, thanks!

  20. Macy
    December 6, 2016

    Thanks!!!

  21. max
    January 3, 2017

    Hi Jacob!

    I WAS GLAD TO FIND SUCH A TOOL FOR UNITY 3D BUT UNFORTUNATELY I CANNOT SEE ANY OPTION under window-tab to choose doxygen documentation. i tried reimport several times. P.s. i use mac with unity 5

  22. Sonny
    May 9, 2017

    Thanks for the great plugin. But I keep getting Nullreferenceexception when clicking on Settings/Configuration on Unity 5.6. Can you help?

Leave a reply