Excellent thread, I am happy to see a documentation tool build specifically
for AS2. I will be following the project Sam. You might want to consider
making it an open source project and posting it at osflash.org. Ian
especially, as well as others look like they'd be interested in
contributing.
Does anyone know if there will be a PC compilation for VisDoc?
H
___
Flashcoders mailing list
Flashcoders@chattyfig.figleaf.com
http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
I have written a documentation tool:
It sits on your desktop as an executable and all you have to do is pass it
the actionscript files:
http://www.as2docs.com/
Follow the link at the top to see what it produces. It really is absurdly
easy to use - point-and-click for your *.as files and
I have written a documentation tool:
It sits on your desktop as an executable and all you have to do is
pass it
the actionscript files:
http://www.as2docs.com/
Is it a Java tool ?
---
erixtekila
http://blog.v-i-a.net/
___
Flashcoders
Yes, its written in Java.
Regards, Sam
On 22/01/06, erixtekila [EMAIL PROTECTED] wrote:
I have written a documentation tool:
It sits on your desktop as an executable and all you have to do is
pass it
the actionscript files:
http://www.as2docs.com/
Is it a Java tool ?
Looks good!
Any chance of a command-line driven version so that I can achieve my goal of
having server-side generated documentation on my SVN box..?
Cheers,
Ian
On 1/22/06, Sam Wootton [EMAIL PROTECTED] wrote:
Yes, its written in Java.
Regards, Sam
Any chance of a command-line driven version so that I can achieve my
goal of
having server-side generated documentation on my SVN box..?
You'd test as2api
my 2 cents
---
erixtekila
http://blog.v-i-a.net/
___
Flashcoders mailing list
Sorry, didn't understand that one...
I have already tested as2api - and unfortunately it comes up with a bunch of
errors on the Linux box and produces no output.
Ian
On 1/22/06, erixtekila [EMAIL PROTECTED] wrote:
Any chance of a command-line driven version so that I can achieve my
goal of
Looks good - but sadly doesn't support inheritance:
http://www.senocular.com/projects/ZenDoc/doc/#manual_limitations
Which is a real shame.
The hunt for the perfect documentation tool goes on. :-)
(At this rate I might be forced to write one. ;-) )
Ian
On 1/20/06, Duncan Reid [EMAIL
Before you write one, please have a look at writing the filter for Doxygen.
Ron
Ian Thomas wrote:
Looks good - but sadly doesn't support inheritance:
http://www.senocular.com/projects/ZenDoc/doc/#manual_limitations
Which is a real shame.
The hunt for the perfect documentation tool goes on.
As far as I can see from the front page (Roadmap panel) it doesn't yet
support JavaDoc as a style, which is a shame...
On 1/18/06, ryanm [EMAIL PROTECTED] wrote:
Or, can anyone suggest an alternative software that takes the java-doc
style comments and create documentation?
Check out
-Original Message-
From: Jobe Makar [mailto:[EMAIL PROTECTED]
Sent: 18 January 2006 14:00
To: Flashcoders mailing list
Subject: Re: [Flashcoders] Documenting my code
Thanks Eric.
I saw BLDoc, but it says its in beta. Is it solid?
Jobe Makar
http://www.electrotank.com
http://www.electro
As far as I can see from the front page (Roadmap panel) it doesn't yet
support JavaDoc as a style, which is a shame...
What doesn't it support?
This is cut and pasted directly from the NaturalDocs documentation:
--
/*
* Function: Multiply
*
I second VisDoc (rocks)
BLDoc for PC
VisDoc for OS X (rocks)
On 1/18/06, Jobe Makar [EMAIL PROTECTED] wrote:
Hi guys,
I've recently purchased AS2Doc to generate documentation from my
ElectroServer class file. The software works pretty well, but it
appears
the
Mirell (company that owns
The keywords @param, @see, @return all have special meaning to JavaDoc based
tools (as well as a host of other @commands). In my limited tests of
NaturalDocs it looks like it doesn't support those special meanings- which
is why the front page of the NaturalDocs site says that JavaDoc is still to
I hope that NaturalDocs does get around to supporting JavaDoc, because in my
test of doc tools over the last week or so it looks like the best fit for me
- it actually runs on my Linux server, whereas most other things are either
Mac or PC based or, like as2api, just cause me server errors. I'm
Hi Martin,
Rather like you - all I have is a script which runs once nightly as a cron
job, does an update from SVN, then calls the doc tool and copies the
generated docs into a folder hosted by the webserver. Nothing complicated.
I'd be interested in seeing a decent AS2 config for Doxygen
I've used Doxygen for a while to document several high-profile
projects and I love it.
The output I got from it indicated that Doxygen didn't understand AS2, and
was
trying to parse the .as files as if they were Java (i.e. class names were
com.something.MyClass rather than just MyClass -
If you want to share your config, perhaps you could post it to this
thread. There are a number of us using Doxygen and its Eclipse plug-in.
I would like to see someone write a Doxygen pre-filter for AS. That is
all that is required to get full ActionScipt support in Doxygen. Filters
have been
Let's all get on MM-Adobe wish list and ask for this! This has been such
a huge issue in every project I've worked on that it puts me back months
to do documentation.
http://www.macromedia.com/cfusion/mmform/index.cfm?name=wishform
Judah
Johan Lopes wrote:
Another thing to note is that
Hi Ron,
Here's a link to download from my Dev server (file size ~14K)
http://www.statik1.com/FlashCoders/DoxyFile.zip
Cheers,
/Johan
On 1/19/06, Ron Wheeler [EMAIL PROTECTED] wrote:
If you want to share your config, perhaps you could post it to this
thread. There are a number of us using
i would much rather them work on releasing a good product than building
stuff like editors(zorn is nice however) and documentation applications when
there are a aready numerous things out there.
On 1/19/06, Judah Frangipane [EMAIL PROTECTED] wrote:
Let's all get on MM-Adobe wish list and ask
I used to use VisDoc but not anymore cause it only runs on
Macs. Used BLDOC for a while and find it stops generating
beyond 5000 line of code (correct me if I'm wrong). My
projects are way too big for it and then I have draw the
diagrams with packages such as Poseidon, ArgoUML or
On 1/19/06, Karina Steffens [EMAIL PROTECTED] wrote:
Nope, you're not wrong. I understand that the limitation is there so that
when they're done with the beta they can start charging for the pro
version,
and keep the community version free. I prefer to keep my classes small and
many, so it
There are a lot of JavaDoc documentation products but very little that
produce the mxi, custom actions and flash help. This takes up a huge
development time. If you have a developer doing Flash Help thank him.
It's actually a lot of work. It's like going back to hand coding html
pages when
Hi Jobe,
I just wrote up a document for using this.
Here it is below:
Email me offlist to get the template file I created.
***
Packaging a component can be quite troublesome. Here are some steps to
help you get the most out of it.
-
Not sure if this has been mentioned but there is also ZenDoc written in php
that has multiple output modes based on templates, i've played a little with
the demo and it looks promising, plus it's free and open as far as i can
tell...
http://www.senocular.com/projects/?project=ZenDocpage=demo
Thanks
Ron
Johan Lopes wrote:
Hi Ron,
Here's a link to download from my Dev server (file size ~14K)
http://www.statik1.com/FlashCoders/DoxyFile.zip
Cheers,
/Johan
On 1/19/06, Ron Wheeler [EMAIL PROTECTED] wrote:
If you want to share your config, perhaps you could post it to this
Hi guys,
I've recently purchased AS2Doc to generate documentation from my
ElectroServer class file. The software works pretty well, but it appears the
Mirell (company that owns it) is now a ghost town or something. There are no
responses to my support requests at all. Emails to their busdev
BLDoc for PC
VisDoc for OS X (rocks)
On 1/18/06, Jobe Makar [EMAIL PROTECTED] wrote:
Hi guys,
I've recently purchased AS2Doc to generate documentation from my
ElectroServer class file. The software works pretty well, but it appears
the
Mirell (company that owns it) is now a ghost town or
flashcoders@chattyfig.figleaf.com
Sent: Wednesday, January 18, 2006 8:57 AM
Subject: Re: [Flashcoders] Documenting my code
BLDoc for PC
VisDoc for OS X (rocks)
On 1/18/06, Jobe Makar [EMAIL PROTECTED] wrote:
Hi guys,
I've recently purchased AS2Doc to generate documentation from my
ElectroServer class
We've jsut started using AS2API -
http://www.badgers-in-foil.co.uk/projects/as2api/ - which works fine for us
on Windows (but had issues on Linux, sadly, although I think that's because
our Linux box needs a good cleanup).
Cheers,
Ian
On 1/18/06, eric dolecki [EMAIL PROTECTED] wrote:
BLDoc
Hi Jobe,
You could consider using Doc-O-Matic it's really nice I use it for all
my .NET, Delphi projects. It also has generic or javascript support...
Yours,
Weyert de Boer
___
Flashcoders mailing list
Flashcoders@chattyfig.figleaf.com
Perhaps someone at Adobe will build a great Documenting application that
ships with Flash 9 or something.
Or perhaps Alessandro can build something that bolts onto SEPY? ;)
-edolecki
On 1/18/06, Weyert de Boer [EMAIL PROTECTED] wrote:
Hi Jobe,
You could consider using Doc-O-Matic it's
Ian Thomas wrote:
We've jsut started using AS2API -
http://www.badgers-in-foil.co.uk/projects/as2api/ - which works fine for us
on Windows (but had issues on Linux, sadly, although I think that's because
our Linux box needs a good cleanup).
Perhaps you could share how you got it working? I
Hi Alan,
That one's pretty simple - we didn't even try. I too get the huge barf of
'no definition' output for the MX classes. But I didn't need to document the
MX classes, so didn't bother looking into how to do so - the output from
as2api _without_ those classes is absolutely fine for what we
Ian Thomas wrote:
Hi Alan,
That one's pretty simple - we didn't even try. I too get the huge barf of
'no definition' output for the MX classes. But I didn't need to document the
MX classes, so didn't bother looking into how to do so - the output from
as2api _without_ those classes is
Or, can anyone suggest an alternative software that takes the java-doc
style comments and create documentation?
Check out NaturalDocs. It's free (open course), and it reads almost any
style of comments.
ryanm
___
Flashcoders mailing list
also could try:
http://www.jellyvision.com/actiondoc/ stand alone and nice
ryanm wrote:
Or, can anyone suggest an alternative software that takes the
java-doc style comments and create documentation?
Check out NaturalDocs. It's free (open course), and it reads almost
any style of
39 matches
Mail list logo
