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

[Theodore A. Roth]

I've just commited this. I did go through it and cleaned things up though, 
so it's not exactly what you sent me. Also made some changes to suppress 
some doxygen warnings about things not being documented. There's a bunch 
of FIXME's in there now that need attention (most should be easy).

I tried to fix up the XXX and ??? stuff. Have a look and see if things are 
more clear now.

Thanks again for doing most of the grunt work Ken. Greatly appreciated. 
Besides, reviewing your patch forced me to think about some things I 
haven't thought about in a while. ;-)

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
>