[Bayes++] Re: Doxygen documentation

[Michael S. <ma...@mi...>]

Hello Fredrick.

On Sunday 25 Sep 2005 23:02, Fredrik Orderud wrote:
> The automatically generated Doxygen documentation for Bayes++ does not seem
> to include the comments found in the code. This is probably due to the fact
> you've written the comments between the function signature and the function
> body; while Doxygen prefers comments to be written before the function
> signatures (or after the body). You will also need to start each comment
> with double asterix' ("/**") to mark them as code-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.

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.

> 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.

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.

Thanks,
	Michael

-- 
___________________________________
Michael Stevens Systems Engineering

34128 Kassel, Germany
Phone/Fax: +49 561 5218038

Navigation Systems, Estimation  and
                 Bayesian Filtering
    http://bayesclasses.sf.net
___________________________________