Documentation tool for the ZSNES source

quad · Post by **quad** » Tue Mar 15, 2005 2:08 am

Hello,

In an attempt to provide a way to document the source code of ZSNES, I have written a small tool in Perl that generates documentation files similar to javadoc based on special comments in the .asm and .inc files.

The following screenshot illustrates an execution over the src directory of ZSNES:

http://quadhome.calizone.net:8000/asmdoc-zsnes.png

It currently recognizes a quite strict comment and labeling format, but I think it could help to provide a wider accessibility to the source for new ZSNES hackers. Also, it has a number of issues regarding its flexibility (eg: current HTML code is directly included in the Perl source, while it should be based on external, easy-to-modify templates, etc.).

Do you think that such a tool could be useful? Any comment would be greatly appreciated, including if something has already been done regarding this. :)

snkcube · Post by **snkcube** » Tue Mar 15, 2005 2:20 am

Your link doesn't work.

quad · Post by **quad** » Tue Mar 15, 2005 2:27 am

Doesn't it? I can see at least one request from the Internet in the log files of my web server and it seems to have worked fine for that person.

What error does it give you?

But thanks for reporting; I'll see if anyone else reports the same... Or perhaps I could post the image somewhere (??).

snkcube · Post by **snkcube** » Tue Mar 15, 2005 2:35 am

Now it works.

Nightcrawler · Post by **Nightcrawler** » Tue Mar 15, 2005 2:28 pm

Sure, I think your tool is useful. I like the looks of it. However.. it can only do so much since ZSNES is pretty limited when it comes to comments. The authors of uncommented unorganized code should do the community a favor and go back and organize and comment it.