🔒 Locked

WANTED: Documentation Generator for Angelscript

Started by _orm_ May 5, 2011 at 1:25 PM 3 replies 2.7k views

Original Post

May 5, 2011 at 1:25 PM

Something that I have been thinking would be handy to have around would be a program like Doxygen that generates documentation for Angelscript code. I already tried using doxygen itself since the syntax is identical to C++ and Java. The result was that the classes were documented, but the class functions and fields were not.

Anyone have any suggestions? Maybe interested in starting up a project?

TheAtom

May 5, 2011 at 6:41 PM

The syntax is not exactly identical (like optional semicolon at the end of a class) and is known to cause parsing bugs in vanilla doxygen. You can try this doxygen build made specifically for the AS: http://svn2.xp-dev.c...ygen/bin/win32/
I know it to be able to document class members, but it's a bit old and may not deal properly with, for instance, the private qualifier.

_orm_

May 7, 2011 at 7:00 PM

Can anyone verify this? Seems a bit fishy to me...

TheAtom

May 8, 2011 at 7:58 PM

"Fishy"...
There's complete .patch file for the doxygen snapshot used for that build together with a brief readme available at http://svn2.xp-dev.c...ls/doxygen/src/ if you have any doubts about the linked binaries.

_orm_

May 13, 2011 at 2:51 AM

Thought I would update youall. NaturalDocs works splendidly with Angelscript!!!

Topic Locked

This topic has been locked by a moderator. New replies are not allowed.