[Xorp-cvs] XORP cvs commit: xorp/docs/kdoc

Pavlin Radoslavov pavlin@icir.org
Thu, 23 Feb 2006 08:46:53 -0800


> On Thu, Feb 23, 2006 at 02:18:44AM +0000, Pavlin Radoslavov wrote:
> > Modified files:
> > 	docs/kdoc     gen-kdoc.sh 
> 
> I believe that I didn't put the right comment header in a lot of the code
> I've committed with kdoc embedded documentation.
> 
> That is, I have
> 
> /*
>  * foo:
> 
> where I should have
> 
> /**
>  * foo:
> 
> This style bug probably only affects code I've added for the Windows support.
> 
> Given that I've never actually *run* Doxygen until last week, it's probably
> not too much of a surprise.
> 
> I can fix this when we plan to update the internal API documentation.

Now we are in the period between a release candidate and the release
itself, so it is the time for documentation changes (including kdoc
fixes like the one above).

Pavlin