Hello,
When I want to write a documentation file for a script I wrote for the Unity Asset store, I usually write that documentation in MS Word and then I convert it to a pdf. Are there better ways to do this? Is there any fancy tool I could use to easily write documentation? The documentation I want to write won’t contain a lot of code, but just some pictures and text that explains the user how they should use my tool.
Thanks in advance,
Alex
Doxygen should work for C# - if the idea is to document code, function calls, etc. You’ll get class hierarchies, etc.
If you want to write a generic manual, any tool thatproduces pdf will do.
I’ve tried it with C# and it actually works pretty well, I’d switch it from C# mode to C++ mode (C# mode is actually Java style which is less appropriate than C#)
Documenting all your code with XML then running Doxygen can generate some very nice documents
The entirety of the Dialogue System for Unity’s online manual is generated by doxygen. The advantages are that the API and user manual are nicely integrated and hyperlinked, which is really helpful for a very extensive product like this. But if you want to also provide a PDF version of complex doxygen output, there aren’t any solutions that will produce as nice a PDF document as creating it from scratch in something like MS Word.
The manuals for Love/Hate and the Save System for RFPSP are simpler, so I wrote them in Libre Office (like MS Office) and exported them as PDF. I still use doxygen to generate the API docs, though.
I’m about to release a documentation generator that covers some of the pitfalls of doxygen. Instead of having it be so verbose like doxygen, I wanted mine to be modern, lightweight, and easy to navigate, e.g, finding a class should be fast. Additionally, I wanted it to be cleanly deployable in an Asset Store package unlike doxygen.
Check it out and give me some feedback.