AS2docGenerator minor update
June 19th, 2004
Finally, i have some minor updates to the AS2docGenerator:
- added suport for the @interface tag,
- you can now add as a parameter a directory containing .as class files (or other directories with .as class files) and it will generate a _docs directory with all the html outputs
example usage:
1) single .as file:
C:\> [path to]AS2docGenerator.exe [path to]AS2class.as
this generates a AS2class_doc.html file in the same directory AS2class.as is in.
2) a directory with .as files and/or other directories:
C:\> [path to]AS2docGenerator.exe [path to]AS2classDirectory
this generates a _docs directory in the same directory where the AS2docGenerator.exe was called from. All the asClass_doc.html files are in the _docs directory.
The project is still in beta so bugs and other naughty insects are possible 
June 19th, 2004 at 10:56 pm
Hi Klaut!,
I’ve been using your great tool (thanks for sharing!) :), and I want you to suggest add a @event tag, so if you create a class with a broadcaster that fires a “onEvent” event you could document as a important info of the class.
Thanks!
June 19th, 2004 at 10:59 pm
Trying to use this from SEPY. Here is the command. J:\Software\Web Design or Developement\Utilities\AS2docGenerator\AS2docGenerator.exe J:\Software\Web Design or Developement\Utilities\AS2docGenerator\SampleClass.as
Here is the output:
Executing: J:\Software\Web Design or Developement\Utilities\AS2docGenerator\AS2docGenerator.exe J:\Software\Web Design or Developement\Utilities\AS2docGenerator\SampleClass.as pid: 2084
Process End, pid:2084, 0: Exit Code
### ERROR: the filename provided does not seem to be a correct file name or directory.
Please, check the filename and try again [hint: classfile.as]
Am I doing something stupid?
June 19th, 2004 at 11:29 pm
jrm02t,
i can generate docs from SEPY without problems (just tried it once again right now)
Did you try following the description on how to use AS2docGenerator from SEPY found at phpFlashWiki?
http://www.sephiroth.it/phpwiki/index.php/How%20to%20use%20As2DocGenerator%20in%20SEPY
June 19th, 2004 at 11:31 pm
carlos,
i’ll add it to the next revision for sure (actually i’ll add it asap) 
thank you for the suggestion
June 20th, 2004 at 11:41 pm
Many thanks klaut!
I’ll think that will be a great adittion, sure! : )
btw, I have another suggestion, really….a minor suggestion:
could be a way to insert a mail adress as a part of the class’s documentation?
I refer to “foo@foosite.com” don’t could be inserted as I won’t be render( due to the interpretation of the @ character as a tag),…but what if you could put something like “foo\@foosite.com” so the mail was correctly inserted as “foo@foosite.com”?
Thanks for listening klaut!
: )
June 21st, 2004 at 10:00 am
Hi Klaut,
I liked your app so much I’ve been writing a GUI for it for personal use in some spare time, just wondered if you wanted me to share this (or send it to you to see if you like it?), requires .Net CLR tho :s
Basic features:
- Drag and drop AS file onto GUI (a preview of file is shown in txt window).
- Browse for AS file with Windows file browser
- Browse for location of AS2DocGenerator if not in default location, save location for future use.
- Auto open Documentation in IE on success
- Echo’s AS2DocGens raw output such as “#####Error” and uses that to prompt user.
I plan to allow for you to drop a folder on and auto-document files in all subfolders (and show you wish ones did not work with error message).
I just made this little extension to learn a bit of C# and also allow me to use your app more often :p hope you don’t mind!
Richard Leggett
June 22nd, 2004 at 12:35 pm
Hi!
Nice to see the project it’s no dead!
I’ve posted it before, but i think it would be great some kind of support for non-english characters like “ñ”, “ó” and things like that.
Anyway, thank you for your time and effort.
Bye!
June 23rd, 2004 at 2:45 am
Congratulations for your blog and your work Klaut !
I was looking for such tool for a while since FlashDoc was trashed by MM
I experienced it with SEPY 1.0.2.5 and I always get:
### ERROR: @class or @interface tag is required.
Is something missing?Thx
June 23rd, 2004 at 11:04 am
Just for dummies like me ¬_¬, try quoting de path:
As2DocGenerator “c:/some folder/as folder”
Enjoy!
June 25th, 2004 at 10:59 am
One “Back to top” link after each method description will help, i think.
Bye!
June 25th, 2004 at 11:12 am
thank you all for your feedback
all your suggestions are valuable and will be added in the next revision.
Also, i’ll try to track down the bugs with the folder paths.
June 25th, 2004 at 3:56 pm
Looks really useful, any chance of porting it to OSX?
June 26th, 2004 at 11:53 pm
Hubert,
unfortunatelly i dont have osx to test the code on, so if you know little python and are willing to port it, please email me at klaut[at]klaustrofobik[dot]org
June 28th, 2004 at 12:30 pm
Your work is great! As2 langauge is like java. A good idea it is use javadoc as guide line. Same tag and system.
Anyway good work!
regards lorenzo
July 3rd, 2004 at 12:00 am
Fantastic Blog
July 6th, 2004 at 1:16 pm
Steven
Power
Ronald
July 9th, 2004 at 9:25 pm
Great Blog!
July 9th, 2004 at 9:31 pm
Great Blog!
July 11th, 2004 at 5:16 pm
nice site
July 13th, 2004 at 2:15 am
Hey Klaut,
Thanks for sharing the sweet prog.
How open to collaboration would you be on this project, if say, someone wanted to help you add some new features?
-Andre
July 13th, 2004 at 7:07 am
Sorry that i am a bit of topic here.
I am looking for technical writer who is compute savvy.
I like how you put your words together. If you are interested could you email me your rates.
July 18th, 2004 at 7:34 pm
I have only just found this and I must say this is awesome.
There is one thing I would like to suggest though. Would it be possible to allow tabs after the keywords (@class, @param etc) then at least the comments in my code would be as readable as my fancy documentation.
Good work