[Doxygen-users] Documenting from inside a function
Brought to you by:
dimitri
|
From: Smith, D. <smi...@ty...> - 2002-02-07 22:31:39
|
<snip>
/**
@fn void foo (const Bar& in_bar,Bar& out_bar)
*/
void foo (const Bar& in_bar,Bar& out_bar)
{
//... some distance into the fn body.
// a point is encountered where it
// would be nice to have a comment
// that is both parsed by Doxygen
// and "in place" in the code.
/**
@note
The stuff immediately after
this comment does something
that I think you should know
about, even if you're too
lazy to look through it all.
*/
out_bar << ::fooify(in_bar);
//...
}
</snip>
Hi,
A quick question. Is it possible to get
Doxygen to associate comment blocks occurring
within a function body with that function? If
not, has anyone found a means to accomplish
something similar that they'd care to share?
Thanks much,
Dave
|