Re: [Flashcoders] Documenting my code
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
Re: [Flashcoders] Documenting my code
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. This way, developing a documentation tool that is capable of handling the sophisticated demand of our community can be possible. Either way, I personally appreciate your work, and respect whatever you please to do with your project. Cheers, H ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
Re: [Flashcoders] Documenting my code
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. It's written in Ruby. Check your version. You'd definitively should ask David Holroyd, he'll guide pretty well… HTH --- erixtekila http://blog.v-i-a.net/ ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
Re: [Flashcoders] Documenting my code
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 > > 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 > Flashcoders@chattyfig.figleaf.com > http://chattyfig.figleaf.com/mailman/listinfo/flashcoders > ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
Re: [Flashcoders] Documenting my code
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 Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
Re: [Flashcoders] Documenting my code
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 > ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
Re: [Flashcoders] Documenting my code
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 ? > --- > erixtekila > http://blog.v-i-a.net/ > > ___ > Flashcoders mailing list > Flashcoders@chattyfig.figleaf.com > http://chattyfig.figleaf.com/mailman/listinfo/flashcoders > ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
Re: [Flashcoders] Documenting my code
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 mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
Re: [Flashcoders] Documenting my code
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 they're documented. Should be completely finished to 2 weeks. Regards, Sam On 20/01/06, Ian Thomas <[EMAIL PROTECTED]> 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. :-) > > (At this rate I might be forced to write one. ;-) ) > > Ian > > On 1/20/06, Duncan Reid <[EMAIL PROTECTED]> wrote: > > > > 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=ZenDoc&page=demo > > > > Dunc > > ___ > > Flashcoders mailing list > > Flashcoders@chattyfig.figleaf.com > > http://chattyfig.figleaf.com/mailman/listinfo/flashcoders > > > ___ > Flashcoders mailing list > Flashcoders@chattyfig.figleaf.com > http://chattyfig.figleaf.com/mailman/listinfo/flashcoders > ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
Re: [Flashcoders] Documenting my code
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. :-) (At this rate I might be forced to write one. ;-) ) Ian On 1/20/06, Duncan Reid <[EMAIL PROTECTED]> wrote: 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=ZenDoc&page=demo Dunc ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
Re: [Flashcoders] Documenting my code
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 PROTECTED]> wrote: > > 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=ZenDoc&page=demo > > Dunc > ___ > Flashcoders mailing list > Flashcoders@chattyfig.figleaf.com > http://chattyfig.figleaf.com/mailman/listinfo/flashcoders > ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
Re: [Flashcoders] Documenting my code
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 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 written for other languages that are much further away from Java than ActionScript. Ron Johan Lopes wrote: 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 - that sort of behaviour). True. If the OPTIMIZE_OUTPUT_JAVA tag is set to YES. Doxygen will then generate output that is more tailored for Java. For instance, namespaces will be presented as packages, qualified scopes will look different, etc. If you just run it with all the default parameters, the packages will look very weird (at least to my Java eyes) i.e. com::MyCompanyName::MyProjectName::MyClassName. I like it when it's dot-syntaxed. Currently, Doxygen doesn't officially support AS. It works best when set to treat AS as a Java-like language, but there's some minor issues with postcolon syntax (:Void etc) especially when you turn on the "show-source-in-the-documentation-feature" <--- it's called something else but you get the idea. I've used most of the documentation tools mentioned on this list and there's always trade-offs, even with commercial ones. I know Doxygen doesn't support AS but I (and most of my clients) love the UML-like diagrams it spits out so I can live with it's other quirks. 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 gModeler (looks good but not useful on large commercial projects). In Doxygen, have you tried turning HIDE_SCOPE_NAMES to YES. It's on NO by default. ' If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen will show members with their full class and namespace scopes in the documentation. If set to YES the scope will be hidden. ' Mail me off-list if you're interested and I'll share my Doxyfile (though I'm not running cron jobs). Time permitting I'm myself very interested to see how easy it would be to mold Doxygen to parse AS classes in a proper fashion. After all the source code is there. It's all open-source and well documented! Another thing to note is that there was a mention at the Spark Conference in Europe that MM-Adobe is considering releasing the documentation tool their Dev team uses internally. We'll see, perhaps with the next big release of the Flash IDE? :) HTH, /Johan ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
Re: [Flashcoders] Documenting my code
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=ZenDoc&page=demo Dunc ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
Re: [Flashcoders] Documenting my code
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. - Create a directory called Release 1.0.0 (replace 1.0.0 with the current version number) in the directory of your component. - Copy the AS2Doc config file to the component root directoy. Rename it to fit your component. AS2DOC Section Open AS2DOC and open your as2doc.xml file. Project Tab - In the projects tab type in a new description. Be sure to save your file at each step. - When you save it delete the file that is there before because sometimes it does not get saved. Source Tab - Switch to the Source tab and select the correct path to your class file or class directory. For example, select the directory that contains all your classes, "com" or select the main component class, "MyComponent.as". Sometimes duplicate files are listed when you select a directory. This happens when you have a copy of the file and leave it in the same directory, "Copy of myComponent.as". Remove this backup to another location. Output Tab - In the output directory select the Release 1.0.0/documentation directory. - In the stylesheet section select "Flash MX 2004 Documentation" - In the stylesheet information section click the configure button. - In the configuration screen check the checkbox "Omit file tags for .as sources". - Enter footer information, "© ACME 2005 - 2006". - In MXI Title enter "ACME Inc. Component". - In MXI Version enter the version "1.0.0". - In MXI Type enter "Flash Component". - In MXI Author type your name or company name - In MXI Description enter component description, "ACME XYZ component for Flash MX 2004 and Flash 8" - In MXI UI Access describe how to get to the component in the Flash IDE, "After installing the extension, you can access it under Components > ACME > MyComponent. Help can be found in the Help Panel under ACME > MyComponent" Options Tab - In the options tab check the Public Members checkbox. - Go back and save your file again. Log Tab - Press the generate button. Now goto the Release 1.0.0\documentation\HelpPanel\Help\myComponent directory and open the introduction.html page in a browser. This allows you to read your help documentation as if you were reading it from within the Flash IDE. Take the time now to read through the documentation following the built in links. - As you read through the introduction page go to the Project tab and change any part of the description you need to. - As you read through the help documentation open up your class file and make changes as you need to. - All comments that contain "< pre >" tag enclosed code should be indented one tab. For example, somecode Now that you've made the changes you need to regenerate the help docs again. Go into the directory Release 1.0.0\documentation\HelpPanel\Help\myComponent and delete all the files there. Go back into AS2Doc and press the generate button again. *** Jobe Makar 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 something. There are no responses to my support requests at all. Emails to their busdev address bounce. My question is this: does anyone know of a good place where I could find support on AS2Doc. Or, can anyone suggest an alternative software that takes the java-doc style comments and create documentation? Jobe Makar http://www.electrotank.com http://www.electro-server.com phone: 919-609-0408 mobile: 919-610-5754 fax: 919-341-8104 ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
Re: [Flashcoders] Documenting my code
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 you've got Dreamweaver 8 on your desktop. I do not know of any good ones out right now but AS2Doc is close. The problem with AS2Doc is that the developer has vanished. No emails I have ever sent to support have been returned and the company that sells his product can no longer get hold of him. This would have been a great circumstance for a source code escrow service. I've just downloaded BLDocs but they've been in beta for a ~year?? So I'm not sure where they are at. Judah PS I will post my notes on how I have got AS2Doc to work for me. Johannes Nel wrote: 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 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 there was a mention at the Spark Conference in Europe that MM-Adobe is considering releasing the documentation tool their Dev team uses internally. We'll see, perhaps with the next big release of the Flash IDE? :) HTH, /Johan ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders -- j:pn ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
Re: [Flashcoders] Documenting my code
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 hasn't been an issue for me yet. Btw, I thought it was 5000 > lines of code per class, not for the whole project? I'm not sure anymore. Nope it's 5000 lines for your whole project. :-) Thus it doesn't work for me either. -Chris ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
RE: [Flashcoders] Documenting my code
> 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 gModeler > (looks good but not useful on large commercial projects). 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 hasn't been an issue for me yet. Btw, I thought it was 5000 lines of code per class, not for the whole project? I'm not sure anymore. Karina ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
Re: [Flashcoders] Documenting my code
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 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 there was a mention at the Spark > >Conference in Europe that MM-Adobe is considering releasing the > >documentation tool their Dev team uses internally. We'll see, perhaps > >with the next big release of the Flash IDE? :) > > > >HTH, > > > >/Johan > >___ > >Flashcoders mailing list > >Flashcoders@chattyfig.figleaf.com > >http://chattyfig.figleaf.com/mailman/listinfo/flashcoders > > > > > > > > > > > > ___ > Flashcoders mailing list > Flashcoders@chattyfig.figleaf.com > http://chattyfig.figleaf.com/mailman/listinfo/flashcoders > -- j:pn ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
Re: [Flashcoders] Documenting my code
Good idea! /Johan On 1/19/06, Judah Frangipane <[EMAIL PROTECTED]> wrote: > 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 there was a mention at the Spark > >Conference in Europe that MM-Adobe is considering releasing the > >documentation tool their Dev team uses internally. We'll see, perhaps > >with the next big release of the Flash IDE? :) > > > >HTH, > > > >/Johan > >___ > >Flashcoders mailing list > >Flashcoders@chattyfig.figleaf.com > >http://chattyfig.figleaf.com/mailman/listinfo/flashcoders > > > > > > > > > > > > ___ > Flashcoders mailing list > Flashcoders@chattyfig.figleaf.com > http://chattyfig.figleaf.com/mailman/listinfo/flashcoders > ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
Re: [Flashcoders] Documenting my code
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 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 written for other languages that are much further away from > Java than ActionScript. > > Ron > > Johan Lopes wrote: > > >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 - that sort of behaviour). > >> > >> > > > >True. If the OPTIMIZE_OUTPUT_JAVA tag is set to YES. Doxygen will then > >generate output that is more tailored for Java. For instance, > >namespaces will be presented as packages, qualified scopes will look > >different, etc. If you just run it with all the default parameters, > >the packages will look very weird (at least to my Java eyes) i.e. > >com::MyCompanyName::MyProjectName::MyClassName. I like it when it's > >dot-syntaxed. > > > >Currently, Doxygen doesn't officially support AS. It works best when > >set to treat AS as a Java-like language, but there's some minor issues > >with postcolon syntax (:Void etc) especially when you turn on the > >"show-source-in-the-documentation-feature" <--- it's called something > >else but you get the idea. > > > >I've used most of the documentation tools mentioned on this list and > >there's always trade-offs, even with commercial ones. I know Doxygen > >doesn't support AS but I (and most of my clients) love the UML-like > >diagrams it spits out so I can live with it's other quirks. > > > >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 gModeler (looks good but not useful on large commercial projects). > > > >In Doxygen, have you tried turning HIDE_SCOPE_NAMES to YES. It's on NO > >by default. > > > >' > >If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen > >will show members with their full class and namespace scopes in the > >documentation. If set to YES the scope will be hidden. > > > >' > > > >Mail me off-list if you're interested and I'll share my Doxyfile > >(though I'm not running cron jobs). > > > >Time permitting I'm myself very interested to see how easy it would be > >to mold Doxygen to parse AS classes in a proper fashion. After all the > >source code is there. It's all open-source and well documented! > > > >Another thing to note is that there was a mention at the Spark > >Conference in Europe that MM-Adobe is considering releasing the > >documentation tool their Dev team uses internally. We'll see, perhaps > >with the next big release of the Flash IDE? :) > > > >HTH, > > > >/Johan > >___ > >Flashcoders mailing list > >Flashcoders@chattyfig.figleaf.com > >http://chattyfig.figleaf.com/mailman/listinfo/flashcoders > > > > > > > > > > > ___ > Flashcoders mailing list > Flashcoders@chattyfig.figleaf.com > http://chattyfig.figleaf.com/mailman/listinfo/flashcoders > ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
Re: [Flashcoders] Documenting my code
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 there was a mention at the Spark Conference in Europe that MM-Adobe is considering releasing the documentation tool their Dev team uses internally. We'll see, perhaps with the next big release of the Flash IDE? :) HTH, /Johan ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
Re: [Flashcoders] Documenting my code
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 written for other languages that are much further away from Java than ActionScript. Ron Johan Lopes wrote: 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 - that sort of behaviour). True. If the OPTIMIZE_OUTPUT_JAVA tag is set to YES. Doxygen will then generate output that is more tailored for Java. For instance, namespaces will be presented as packages, qualified scopes will look different, etc. If you just run it with all the default parameters, the packages will look very weird (at least to my Java eyes) i.e. com::MyCompanyName::MyProjectName::MyClassName. I like it when it's dot-syntaxed. Currently, Doxygen doesn't officially support AS. It works best when set to treat AS as a Java-like language, but there's some minor issues with postcolon syntax (:Void etc) especially when you turn on the "show-source-in-the-documentation-feature" <--- it's called something else but you get the idea. I've used most of the documentation tools mentioned on this list and there's always trade-offs, even with commercial ones. I know Doxygen doesn't support AS but I (and most of my clients) love the UML-like diagrams it spits out so I can live with it's other quirks. 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 gModeler (looks good but not useful on large commercial projects). In Doxygen, have you tried turning HIDE_SCOPE_NAMES to YES. It's on NO by default. ' If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen will show members with their full class and namespace scopes in the documentation. If set to YES the scope will be hidden. ' Mail me off-list if you're interested and I'll share my Doxyfile (though I'm not running cron jobs). Time permitting I'm myself very interested to see how easy it would be to mold Doxygen to parse AS classes in a proper fashion. After all the source code is there. It's all open-source and well documented! Another thing to note is that there was a mention at the Spark Conference in Europe that MM-Adobe is considering releasing the documentation tool their Dev team uses internally. We'll see, perhaps with the next big release of the Flash IDE? :) HTH, /Johan ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
Re: [Flashcoders] Documenting my code
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 - that sort of behaviour). True. If the OPTIMIZE_OUTPUT_JAVA tag is set to YES. Doxygen will then generate output that is more tailored for Java. For instance, namespaces will be presented as packages, qualified scopes will look different, etc. If you just run it with all the default parameters, the packages will look very weird (at least to my Java eyes) i.e. com::MyCompanyName::MyProjectName::MyClassName. I like it when it's dot-syntaxed. Currently, Doxygen doesn't officially support AS. It works best when set to treat AS as a Java-like language, but there's some minor issues with postcolon syntax (:Void etc) especially when you turn on the "show-source-in-the-documentation-feature" <--- it's called something else but you get the idea. I've used most of the documentation tools mentioned on this list and there's always trade-offs, even with commercial ones. I know Doxygen doesn't support AS but I (and most of my clients) love the UML-like diagrams it spits out so I can live with it's other quirks. 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 gModeler (looks good but not useful on large commercial projects). In Doxygen, have you tried turning HIDE_SCOPE_NAMES to YES. It's on NO by default. ' If the HIDE_SCOPE_NAMES tag is set to NO (the default) then Doxygen will show members with their full class and namespace scopes in the documentation. If set to YES the scope will be hidden. ' Mail me off-list if you're interested and I'll share my Doxyfile (though I'm not running cron jobs). Time permitting I'm myself very interested to see how easy it would be to mold Doxygen to parse AS classes in a proper fashion. After all the source code is there. It's all open-source and well documented! Another thing to note is that there was a mention at the Spark Conference in Europe that MM-Adobe is considering releasing the documentation tool their Dev team uses internally. We'll see, perhaps with the next big release of the Flash IDE? :) HTH, /Johan ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
Re: [Flashcoders] Documenting my code
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 too. 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 - that sort of behaviour). Cheers, Ian On 1/19/06, Martin Wood <[EMAIL PROTECTED]> wrote: > > out of curiosity how are going about this on the linux box? > > I implemented a system a while ago to do nightly documentation builds on > a linux box, but my system was based around CVS / Doxygen. > > Basically, I wrote a python script that was called as a cron job which > checked out all the projects from CVS, ran doxygen on them and copied > the output to a local web server.. > > Unfortunately i dont have access to the code anymore because it was > built for my previous employer but im keen on getting something working > for myself that uses SVN and produces docs for AS2 code (as well as > Java, even if that means using seperate tools..) > > the nice thing about using doxygen (after a bit of configuration work) > was that the documentation for seperate projects was linked together. > e.g. If project B depended on project A (a library) then you could > follow links from B to the relevant places in A. (and you got diagrams > for free..) > > I'd be interested to see if anyone has some configs for doxygen that > work well with AS2, or if you think that a specific AS2 module for > doxygen is needed.. > ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
Re: [Flashcoders] Documenting my code
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 trying to integrate a doc-tool in to our SVN setup (so that nightly up-to-date docs are built) and am having no luck at all. At the moment I'm having to run something scheduled on my Windows box to achieve it. out of curiosity how are going about this on the linux box? I implemented a system a while ago to do nightly documentation builds on a linux box, but my system was based around CVS / Doxygen. Basically, I wrote a python script that was called as a cron job which checked out all the projects from CVS, ran doxygen on them and copied the output to a local web server.. Unfortunately i dont have access to the code anymore because it was built for my previous employer but im keen on getting something working for myself that uses SVN and produces docs for AS2 code (as well as Java, even if that means using seperate tools..) the nice thing about using doxygen (after a bit of configuration work) was that the documentation for seperate projects was linked together. e.g. If project B depended on project A (a library) then you could follow links from B to the relevant places in A. (and you got diagrams for free..) I'd be interested to see if anyone has some configs for doxygen that work well with AS2, or if you think that a specific AS2 module for doxygen is needed.. thanks, martin. ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
Re: [Flashcoders] Documenting my code
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 be supported (the Roadmap section). By not supported I mean that it looks like NaturalDocs - if it does anything with them at all - just copies them verbatim, without using them for crossreferencing or anything. 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 trying to integrate a doc-tool in to our SVN setup (so that nightly up-to-date docs are built) and am having no luck at all. At the moment I'm having to run something scheduled on my Windows box to achieve it. We're not going to switch to NaturalDocs 'natural' commenting style over the JavaDoc style for the simple reason that more tools, longterm, will support the JavaDoc tags and I want to retain the flexibility to switch doc tools. And we've already got a load of code commented in this style. :-) I used to use Doxygen for this in Java - but to be honest Doxygen's output for AS2 seems pretty poor - unless I'm missing a config trick somewhere... Ian On 1/19/06, ryanm <[EMAIL PROTECTED]> wrote: > > > 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? > ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
Re: [Flashcoders] Documenting my code
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 it) is now a ghost town or something. There are no responses to my support requests at all. Emails to their busdev address bounce. My question is this: does anyone know of a good place where I could find support on AS2Doc. Or, can anyone suggest an alternative software that takes the java-doc style comments and create documentation? Jobe Makar http://www.electrotank.com http://www.electro-server.com phone: 919-609-0408 mobile: 919-610-5754 fax: 919-341-8104 ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
Re: [Flashcoders] Documenting my code
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 * Multiplies two integers and returns the result. */ and /* Function: Multiply Multiplies two integers. Parameters: x - The first integer. y - The second integer. Returns: The two integers multiplied together. See Also: */ -- This was cut and pasted directly from the Sun spec on javadoc comments: -- /** * Registers the text to display in a tool tip. The text * displays when the cursor lingers over the component. * * @param text the string to display. If the text is null, * the tool tip is turned off for this component. */ -- The whole idea of NaturalDocs is that it doesn't care what style of comments you use, it will work with almost any style. All that said, if you look around I'm sure you can find a number of open source documentation generators based on the javadoc comment style. ryanm ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
RE: [Flashcoders] Documenting my code
Hi Jobe, I'm using BLDoc and it's pretty good, especially for a free/beta version. Since it's free, you can always give it a try and see if you like it. You can also get support when joining their beta mailing list, although that's been rather quiet for the last few months. Karina > -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-server.com > phone: 919-609-0408 > mobile: 919-610-5754 > fax: 919-341-8104 > - Original Message - > From: "eric dolecki" <[EMAIL PROTECTED]> > To: "Flashcoders mailing list" > 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 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 address > > bounce. > > > > My question is this: does anyone know of a good place where > I could find > > support on AS2Doc. Or, can anyone suggest an alternative > software that > > takes > > the java-doc style comments and create documentation? > > > > Jobe Makar > > http://www.electrotank.com > > http://www.electro-server.com > > phone: 919-609-0408 > > mobile: 919-610-5754 > > fax: 919-341-8104 > > > > > > ___ > > Flashcoders mailing list > > Flashcoders@chattyfig.figleaf.com > > http://chattyfig.figleaf.com/mailman/listinfo/flashcoders > > > ___ > Flashcoders mailing list > Flashcoders@chattyfig.figleaf.com > http://chattyfig.figleaf.com/mailman/listinfo/flashcoders > > > ___ > Flashcoders mailing list > Flashcoders@chattyfig.figleaf.com > http://chattyfig.figleaf.com/mailman/listinfo/flashcoders > > ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
Re: [Flashcoders] Documenting my code
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 NaturalDocs. It's free (open course), and it reads almost > any > style of comments. > > ryanm > ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
Re: [Flashcoders] Documenting my code
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 comments. ryanm ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
Re: [Flashcoders] Documenting my code
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 Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
Re: [Flashcoders] Documenting my code
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 absolutely fine for what we want. Hm, well, it's fine for me, too -- the multiple pages of errors just offends my tender sensibilities. Thanks! ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
Re: [Flashcoders] Documenting my code
As always I recommend Doxygen. There's a comprehensive tutorial on how to set it up with eclipse on my blog site: http://www.statik1.com/mt-weblog/archives/92.html /Johan On 1/18/06, Ian Thomas <[EMAIL PROTECTED]> 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 absolutely fine for what we want. > > Sorry I couldn't be of more help! > Ian > > On 1/18/06, Alan MacDougall <[EMAIL PROTECTED]> wrote: > > > > 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 just tried it with a > > command line like this: > > > > as2api --classpath path/to/swfRoot;path/to/commonLib > > com.alanmacdougall.project.* > > > > (I have all my classes arranged properly at swfRoot/com/etc/etc, with > > utility classes like XFactorStudio's XPath at a common library location.) > > > > First it barfed when it found variable definitions in the style "private > > var x:Number, y:Number;" -- so I fixed those. But then it started giving > > me huge streams of errors saying "Found no definition of type known > > locally as 'MovieClip'". > > > > Again, I think, no problem -- I add flash_home/en/First Run/Classes/FP8 > > and flash_home/en/First Run/Classes/MX to the classpath... but without > > success. > > > > Could you post your experiences with as2api, and the command line > > parameters you're using? I'd appreciate it. > > > > Alan > > > > ___ > > Flashcoders mailing list > > Flashcoders@chattyfig.figleaf.com > > http://chattyfig.figleaf.com/mailman/listinfo/flashcoders > > > ___ > Flashcoders mailing list > Flashcoders@chattyfig.figleaf.com > http://chattyfig.figleaf.com/mailman/listinfo/flashcoders > ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
Re: [Flashcoders] Documenting my code
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 want. Sorry I couldn't be of more help! Ian On 1/18/06, Alan MacDougall <[EMAIL PROTECTED]> wrote: > > 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 just tried it with a > command line like this: > > as2api --classpath path/to/swfRoot;path/to/commonLib > com.alanmacdougall.project.* > > (I have all my classes arranged properly at swfRoot/com/etc/etc, with > utility classes like XFactorStudio's XPath at a common library location.) > > First it barfed when it found variable definitions in the style "private > var x:Number, y:Number;" -- so I fixed those. But then it started giving > me huge streams of errors saying "Found no definition of type known > locally as 'MovieClip'". > > Again, I think, no problem -- I add flash_home/en/First Run/Classes/FP8 > and flash_home/en/First Run/Classes/MX to the classpath... but without > success. > > Could you post your experiences with as2api, and the command line > parameters you're using? I'd appreciate it. > > Alan > > ___ > Flashcoders mailing list > Flashcoders@chattyfig.figleaf.com > http://chattyfig.figleaf.com/mailman/listinfo/flashcoders > ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
Re: [Flashcoders] Documenting my code
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 just tried it with a command line like this: as2api --classpath path/to/swfRoot;path/to/commonLib com.alanmacdougall.project.* (I have all my classes arranged properly at swfRoot/com/etc/etc, with utility classes like XFactorStudio's XPath at a common library location.) First it barfed when it found variable definitions in the style "private var x:Number, y:Number;" -- so I fixed those. But then it started giving me huge streams of errors saying "Found no definition of type known locally as 'MovieClip'". Again, I think, no problem -- I add flash_home/en/First Run/Classes/FP8 and flash_home/en/First Run/Classes/MX to the classpath... but without success. Could you post your experiences with as2api, and the command line parameters you're using? I'd appreciate it. Alan ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
Re: [Flashcoders] Documenting my code
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 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 > http://chattyfig.figleaf.com/mailman/listinfo/flashcoders > ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
Re: [Flashcoders] Documenting my code
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 http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
Re: [Flashcoders] Documenting my code
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 for PC > VisDoc for OS X (rocks) > ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
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-server.com phone: 919-609-0408 mobile: 919-610-5754 fax: 919-341-8104 - Original Message - From: "eric dolecki" <[EMAIL PROTECTED]> To: "Flashcoders mailing list" 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 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 address bounce. My question is this: does anyone know of a good place where I could find support on AS2Doc. Or, can anyone suggest an alternative software that takes the java-doc style comments and create documentation? Jobe Makar http://www.electrotank.com http://www.electro-server.com phone: 919-609-0408 mobile: 919-610-5754 fax: 919-341-8104 ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
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 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 address > bounce. > > My question is this: does anyone know of a good place where I could find > support on AS2Doc. Or, can anyone suggest an alternative software that > takes > the java-doc style comments and create documentation? > > Jobe Makar > http://www.electrotank.com > http://www.electro-server.com > phone: 919-609-0408 > mobile: 919-610-5754 > fax: 919-341-8104 > > > ___ > Flashcoders mailing list > Flashcoders@chattyfig.figleaf.com > http://chattyfig.figleaf.com/mailman/listinfo/flashcoders > ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
[Flashcoders] Documenting my code
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 address bounce. My question is this: does anyone know of a good place where I could find support on AS2Doc. Or, can anyone suggest an alternative software that takes the java-doc style comments and create documentation? Jobe Makar http://www.electrotank.com http://www.electro-server.com phone: 919-609-0408 mobile: 919-610-5754 fax: 919-341-8104 ___ Flashcoders mailing list Flashcoders@chattyfig.figleaf.com http://chattyfig.figleaf.com/mailman/listinfo/flashcoders
