Re: [Bayes++] Re: Doxygen documentation

[Fredrik O. <fre...@id...>]

----- Original Message ----- 
From: "Michael Stevens" <ma...@mi...>
To: <bay...@li...>
Sent: Tuesday, September 27, 2005 10:01 PM
Subject: [Bayes++] Re: Doxygen documentation

> I started work on some experimental Doxygen comments once before. It 
> didn't
> get very far. There are still some /** comments in unsFlt.xpp.
>
> Apart from the time required I came across two problems.
> a) Many of the member functions group naturally together. In the resulting
> documentation I wanted to keep this grouping. That is with a function
> declerations followed by the explanitory text.

You probably have to modify your comments to be either above the functions; 
or after, on the same line. It would be far easier to get into Bayes++ if 
the doxgen-doc had been improved to also include function descriptions.

> b) At the moment the comments are seperated between the .cpp and .hpp 
> files.
> In the .hpp there are shorter interface comments related to the interface
> specification. In the .cpp files there are algorithm descriptions. I was
> never clear how I would put all this together.

You can choose which commments to use for documentation, by using "/**" in 
.cpp and "/*" in .hpp, or vice versa. But I think the .hpp commments takes 
predecence if you use "/**" in both .hpp and .cpp.

>> I would gladly help you in the task of "fixing" the comments to comply 
>> with
>> Doxygen if you're interested in any help.
>
> That would be very helpful and a great offer. From your previous comments 
> I
> assume you are using code from the CVS HEAD and not one of the 2003.8
> releases.

Yes, I've been using the CVS-code. I am, however, quite fresh when it comes 
to sourceforge-projects. I only registered recently, with username 
"orderud". How does one gain write-access to the repostories?

> I have been working on this code recently with the aim of putting out a 
> new
> release based on the code in the HEAD. I have some ideas how to intergrate
> the 'by-product' work in the head with the previous interface.
>
> The CVS HEAD also has and FAQ page. Which I think will help in the future.
> Any other ideas how improve the documentation would also be great.

I assume your'e talking about "Bayes++FAQ.html", which seems to be an 
improved and extended version of the FAQ on the website. The improved "noise 
coupling" answer looks like a most welcome addition, as the sourcecode is a 
bit vauge on this.

regards,
Fredrik Orderud