RE: [Vxl-maintainers] Re: Questions about vil2

[Andrew F. <aw...@ro...>]

> 
> Concerning the use of external vs member functions.
> I  am beginning to favour external functions for all but the 
> essential operations for
> vil2_image_view, as there are so many things one might want 
> to do, you end up with a
> bloated interface.
> Brendan points out a big problem with this is that, at 
> present, its hard to figure out
> what external functions actually exist for a class.
> Part of the problem is that Doxygen doesn't seem to deal with 
> stand alone functions very
> well - they don't get included anywhere obvious.
> Does anyone know if this can be fixed?  I've resorted to 
> listing the key useful functions
> in the introduction_doxy.txt file, so there is a clear record 
> of what is there, but this
> is
> clearly not an ideal solution.

How about adding a doxy markup command which says, for
functions, which classes' pages they should go on?

E.g.

//: Multiply matrix and vector
//!classes: vnl_matrix, vnl_vector
vnl_vector operator*(vnl_matrix, vnl_vector);

This also means that when there is code which one
does not want to document, one simply avoids the 
"classes:" tag.  Also, there may be things we don't
care to document in the argument list.  For example,
not every function taking a vnl_vector should
be listed on the vnl_vector page.

//: Compute frobnosticated component projection of v
//!classes: frobber, projector
vnl_vector fcp(frobber f, projector p, vnl_vector v);