asunit-users

RE: [Asunit-users] Great tool, but where's the documentation?

[Kristopher S. <ksc...@re...>]

Thanks, Luke! Luckily, I did have enough of a basic understanding of
JUnit to get things working, and I did sift through the source code to
discover the available asserts. Once I spend a little more time with
ASUnit, I'll be happy to put together some documentation!

Kris
=20
--=20
=20
Kristopher Schultz
Developer
=20
Resource Interactive
p: 614.410.2123
www.resource.com
=20

> -----Original Message-----
> From: Luke Bayes [mailto:lb...@gm...]=20

> The truth is that until this very week, most of the people=20
> participating in AsUnit did seem to have experience with=20
> other xUnit frameworks. So documentation has not been as high=20
> a priority as adding features and bug fixing...

RE: [Asunit-users] Great tool, but where's the documentation?

[Kristopher S. <ksc...@re...>]

Luke,

I've checked out the source from CVS. I'm anxious to get started, so =
whenever you want to check in the latest stuff I'll go ahead and update =
my files.

As far as a javadoc parser for AS, I use AS2Doc (http://www.as2doc.com). =
It's not free, but I prefer it because it will output so so many formats =
- HTML, Rich Text, Flash Help, XML - and has support for XSLT. But it's =
been a few months sinced I've looked at the state of the free AS doc =
parsers out there, so maybe there are some decent free alternatives.

Kris

Re: [Asunit-users] Great tool, but where's the documentation?

[Luke B. <lb...@gm...>]

Hey Kris,

I've been using CVS for a long time now too - but I'm also very
inexperienced when it comes to dealing with patches! Maybe we can
learn this thing together. ;-)

I've checked in my branch - the head revision should be all set for
you to do an update.

What platform are you running?=20

I use Windows which means that I get to use Tortoise SVN. In this
case, you can just right click on a CVS repository and choose "Create
Patch". This will generate a .patch text file that contains all of
your changes. You can simply email me that patch file, I can easily
integrate on my end and then you'll need to do another update.

One thing that has worked pretty well for me in the past, was to
actually copy the cvs directories into my Macromedia Configuration
directory. Then I can edit the actual files as they're being used,
test them, and update them periodically to get the latest. I wouldn't
recommend "leaving" your config in this state, but for periods of
heavy development, it helps find the simple errors sooner.

I just did a quick google search on "create cvs patch file" and there
seem to be a lot of resources out there.

Here's the first one that came up for me:
http://owen.sj.ca.us/rkowen/howto/cvs.html#patch

Basically, what I'll be looking for is a single .patch file that
includes all changes that you've made since the repository was last
updated.

Thanks,


Luke Bayes
www.asunit.com

RE: [Asunit-users] Great tool, but where's the documentation?

[Kristopher S. <ksc...@re...>]

Thanks, Luke.

>What platform are you running?

At home I tend to use the Mac and at work I tend to use Windows. I'm =
using Eclipse on both platforms, so I'll go ahead an use its built-in =
CVS support which seems to allow me to create patch files easily, so I =
think I'm all set there.

How frequently would you prefer that I send you patch files? I've =
finished documenting the Assert class. Should I send a patch file =
containing those changes to you now, or should I wait until I have more =
classes finished?

Also, I've decided to use Dave's as2api utility as my reference doc =
generator when proofing my doc comments. I've chosen as2api because a) =
I'd like to support Dave's efforts (thanks, Dave!), b) using as2api =
should help ensure that the doc comment formatting will parse properly =
in any doc gen tool that supports javadoc style tags, and c) it's free. =
There are some downsides, however. From what I can tell, as2api can not =
currently generate XHTML-compliant markup (and in fact, the markup =
required to get the doc comments to display properly will likely have to =
change if as2api ever does become XHTML-compliant), and it doesn't =
support alternate output formats - especially Flash Help and XML.

Kris




-----Original Message-----
From: Luke Bayes [mailto:lb...@gm...]
Sent: Mon 7/4/2005 7:24 PM
To: Kristopher Schultz
Cc: asu...@li...
Subject: Re: [Asunit-users] Great tool, but where's the documentation?
=20
Hey Kris,

I've been using CVS for a long time now too - but I'm also very
inexperienced when it comes to dealing with patches! Maybe we can
learn this thing together. ;-)

I've checked in my branch - the head revision should be all set for
you to do an update.

What platform are you running?=20

I use Windows which means that I get to use Tortoise SVN. In this
case, you can just right click on a CVS repository and choose "Create
Patch". This will generate a .patch text file that contains all of
your changes. You can simply email me that patch file, I can easily
integrate on my end and then you'll need to do another update.

One thing that has worked pretty well for me in the past, was to
actually copy the cvs directories into my Macromedia Configuration
directory. Then I can edit the actual files as they're being used,
test them, and update them periodically to get the latest. I wouldn't
recommend "leaving" your config in this state, but for periods of
heavy development, it helps find the simple errors sooner.

I just did a quick google search on "create cvs patch file" and there
seem to be a lot of resources out there.

Here's the first one that came up for me:
http://owen.sj.ca.us/rkowen/howto/cvs.html#patch

Basically, what I'll be looking for is a single .patch file that
includes all changes that you've made since the repository was last
updated.

Thanks,


Luke Bayes
www.asunit.com

Re: [Asunit-users] Great tool, but where's the documentation?

[David H. <wa...@us...>]

On Mon, Jul 04, 2005 at 10:44:30PM -0400, Kristopher Schultz wrote:
> Also, I've decided to use Dave's as2api utility as my reference doc
> generator when proofing my doc comments. I've chosen as2api because a)
> I'd like to support Dave's efforts (thanks, Dave!), b) using as2api
> should help ensure that the doc comment formatting will parse properly
> in any doc gen tool that supports javadoc style tags, and c) it's
> free.

Cool!  If there's anything I can do to help, just let me know (maybe on
as2api-dev -- to keep off-topic discussion away from the asunit list).


> There are some downsides, however. From what I can tell, as2api can
> not currently generate XHTML-compliant markup (and in fact, the markup
> required to get the doc comments to display properly will likely have
> to change if as2api ever does become XHTML-compliant),

I put a bit of effort into making output from the as2api 0.3 release
validate against the XHTML DTDs.  Are you using an older version, or did
I miss some bugs?


> and it doesn't support alternate output formats - especially Flash
> Help and XML.

I spend next-to-no time using the MM Flash IDE, so I'm more motivated to
get the HTML output working really well, for the moment.  [ I'll accept
patches ;) ]


dave

-- 
http://david.holroyd.me.uk/

Re: [Asunit-users] Great tool, but where's the documentation?

[David H. <wa...@us...>]

On Tue, Jul 05, 2005 at 09:33:03AM +0000, David Holroyd wrote:
> Cool!  If there's anything I can do to help, just let me know (maybe on
> as2api-dev -- to keep off-topic discussion away from the asunit list).

I forgot to mention that's I've recently committed to CVS something to
help projects which are a light on documentation.

The usual mantra is 'use the source', so I've added an option for
including the sourcecode in the documentation.  It looks like this,

http://www.badgers-in-foil.co.uk/projects/as2api/examples/asunit_20050705_apidoc/frameset.html

(Look at documentation for one of the classes.  The 'Source' option in
the navigation will become available, letting you see the entire
implementation of the API you were just looking at.)


dave

-- 
http://david.holroyd.me.uk/

Re: [Asunit-users] Great tool, but where's the documentation?

[Luke B. <lb...@gm...>]

Hey Kris,

Great question on the patch - the main idea behind the patches is that
you will be delayed between the time you send it, and the time I
integrate it. So if you hit a point where you aren't going to be
working on it for a few hours, go ahead and send the patch - I'll try
to be quick about integration, the way I understand it, you'll then
need to do an update. To get the latest sources. I *hope* that it will
simply mark your files as "current", but there is a risk that you'll
have to do some kind of "get the clean copy" or something, which would
be a drag. So maybe it would be good to get that Assert patch now and
we can figure out how this thing is going to work for us.

Also - I use Yahoo messenger - do you? It would be good to get
slightly more real-time than email for these early efforts... (I'm
foreeldo2001)

I don't have a preference for the doc gen tool - I'm assuming they all
parse the same style comments, right? So there shouldn't be a high
cost if there is a need to switch?

As far as using David's build, I support that decision especially
considering free is better than not. I also agree with David in that
getting documentation in the highly unusable IDE doc engine is an
extremely low priority for me too.


Thanks again!


Luke Bayes
www.asunit.com

Re: [Asunit-users] Great tool, but where's the documentation?

[Luke B. <lb...@gm...>]

Hey Kris,

> Would it be possible for me to contribute to the ASUnit project by
> adding javadoc-style comments to the code? That way we could export
> javadoc-style API documentation easily. If you think this is a good
> idea, just let me know what I need to do to be added to the contributors
> list. Thanks!

YES! It would definitely be possible. Basically, what we'll need, is
for you to use anonymous cvs access to the sourceforge repository,
make whatever changes you want, and send us a "Patch" file.

If you're on Windows, this is amazingly easy to do using tortoise cvs.
http://www.tortoisecvs.org/

If you're on mac search for something call eapcvs or something like
that - it's a gui java cvs client.

here are the instructions for pulling down the sources vis CVS:
http://sourceforge.net/cvs/?group_id=3D108947

Whenever you want to do a check-in just send me the .patch file and
I'll review, give feedback and integrate!

Just to save us all some time and trouble, please fire off an email
whenever you start working so that i can make sure to commit and you
can make sure to update to the latest sources. This will help us avoid
conflicts and time-consuming merges.

As far as the actual JavaDoc comments, I know there are a few JavaDoc
ActionScript engines out there - does anyone have any opinions about
which are better and why?


Welcome Aboard Kris!


Luke Bayes
www.asunit.com

Re: [Asunit-users] Great tool, but where's the documentation?

[David H. <wa...@us...>]

On Fri, Jul 01, 2005 at 12:22:40PM -0700, Luke Bayes wrote:
> As far as the actual JavaDoc comments, I know there are a few JavaDoc
> ActionScript engines out there - does anyone have any opinions about
> which are better and why?

*grin*

I kinda like this one,

  http://www.badgers-in-foil.co.uk/projects/as2api/

I am, of course, very biased.


dave

-- 
http://david.holroyd.me.uk/

RE: [Asunit-users] Great tool, but where's the documentation?

[Keith P. <kp...@bi...>]

When I finish my current writing project, I'll probably post a few tutorials
on getting started with AsUnit.

Keith


> -----Original Message-----
> From: asu...@li... 
> [mailto:asu...@li...] On Behalf 
> Of David Holroyd
> Sent: Friday, July 01, 2005 3:34 PM
> To: asu...@li...
> Subject: Re: [Asunit-users] Great tool, but where's the documentation?
> 
> On Fri, Jul 01, 2005 at 12:22:40PM -0700, Luke Bayes wrote:
> > As far as the actual JavaDoc comments, I know there are a 
> few JavaDoc 
> > ActionScript engines out there - does anyone have any 
> opinions about 
> > which are better and why?
> 
> *grin*
> 
> I kinda like this one,
> 
>   http://www.badgers-in-foil.co.uk/projects/as2api/
> 
> I am, of course, very biased.
> 
> 
> dave
> 
> --
> http://david.holroyd.me.uk/
> 
> 
> -------------------------------------------------------
> SF.Net email is sponsored by: Discover Easy Linux Migration Strategies
> from IBM. Find simple to follow Roadmaps, straightforward articles,
> informative Webcasts and more! Get everything you need to get up to
> speed, fast. http://ads.osdn.com/?ad_id=7477&alloc_id=16492&op=click
> _______________________________________________
> Asunit-users mailing list
> Asu...@li...
> https://lists.sourceforge.net/lists/listinfo/asunit-users
> 
>