Re: [Simulavr-devel] Some doxygen-ified comments

[Theodore A. Roth]

Thanks Ken.

I'll try to go through this early next week since I've got other things to 
tend to right now (like getting my resume together so I can find a job ;)

I just gave it a quick glance and most of it looks good. There is places 
where I had comments like "Access Methods for ..." and then a group of 
functions. It might be better to have a doxy entry for each function.

Also, instead of using XXX or ???, just put a "FIXME: krestivo <date>: 
..." in so it will attract more attention and be consistent with my other 
fixme comments.

Other than that, it looks fine. If you wish to tune it up some before I go 
to merge it next week, that is fine with me. ;-)

Ted Roth

On Thu, 14 Mar 2002, ken restivo wrote:

>OK, here are some doxygen comments. Think I got most of 'em here.
>
>I put in XXX's or ???'s in a few places where I wasn't clear on what was
>going on.  But the stuff that I *was* clear on might be even more wrong,
>so you want to look through it all.
>
>I am sorry for the style issues. I'm one of those poor blighted vi users
>and I'm (not (powered (by (emacs)))) just yet. I did my data entry on two
>machines, one of whose vimrc's does *'s down the left, the other doesn't.
>Again, sorry for the inconsistency.
>
>As I went through this, I thought a class/inheritance diagram might be
>useful too. I don't know how to get doxygen to generate one for this
>object-oriented c, but I think it does them automatically for c++.
>
>BTW, I was intrigued by the nifty timer_0_read stuff: it looks like a
>clever way to avoid having to use threads. Very cool.
>
>I built the docs and took a look at it, it seems clean to me.
>
>Anyway, hope this helps. If it's really awful, let me know and I'll go
>back and fix stuff and re-send.
>
>Cheers!
>
>
>-ken
>