Indie game storeFree gamesFun gamesHorror games
Game developmentAssetsComics
SalesBundles
Jobs
Tags

DocMaker for Unity

A topic by Playniax created Apr 01, 2022 Views: 356 Replies: 4
Viewing posts 1 to 4

Hi all,

I am the author (or one of the authors) of game assets that can be found under the name Playniax on itch.io and the Unity Asset Store.

We are a 2 men team.

Not only do we sell graphics but we also sell game templates, frameworks and other useful stuff for Unity.

These products need documentation and so I got this idea for a documentation generator a while back.

DocMaker (for lack for a better name) takes comments from your scripts and converts it to a HTML based page or pages.

I couldn’t find a similar tool that could do the job for me so I created my own and for now it is only intended for internal use at Playniax but I may take the rough edges offin the future and release it to the public.

Do any of you guys know a similar tool and do you think people would be interested in such a tool?

If will probably turn it in to a commercial product if there is enough interest.

Anyway here are the latest docs created by the DocMaker.

Best regards,

Tony

[IMG]

(1 edit) (+1)

I have used doxygen ( https://www.doxygen.nl/index.html ) for that purpose. It supports various languages (I used it for C#), and exports to different formats, including html, but also LaTeX (which in turn can create PDFs with hyperlinks, etc).

If your tool compares well to that in some aspects (more powerful? easier to use?), you might consider releasing it...

I haven't tried doxygen on Unity projects yet though - it might be that that doesn't work very well (with Unity specific things like [SerializeField] tags), so that could be your USP too.

(1 edit)

Thanks PaulsGames, 

Doxygen looks promising and I will explore it when I have a bit more time.

If I ever release my tool for the public it will probably only support Unity and it is a fun project to do but it is still very rough around the edges to use.

(2 edits)

I used doxygen  and I've seen various others that I can't all remember. I just saw this, which seems tailored to .NET (and thus should work well with Unity code).

https://dotnet.github.io/docfx/

But there's always room for a new tool, especially if it's tailored to a specific language or framework. A long time ago I wrote an HTML doc exporter for Common Lisp code because I wanted to generate information from runtime (function doc strings and class hierarchies, for example). If you package yours up to conveniently install from the Unity Asset Store and run from the Unity Editor, I think there'll be interest in it.

For a deep historical dive, PaulsGames mentioned LaTeX, which is descended from TeX, which was part of Donald Knuth's push for "literate programming"

http://literateprogramming.com/

(+1)

Thanks for that. I wil have a look at it.