Re: [Doxygen-users] Documenting same functions with different names.

[Nick M. <nic...@gm...>]

Christoph:

I would suggest you simply write in the comments what you just wrote
to us in your email:

/*!
  \brief A convenience call
  This function is just a convenience call, it actually calls clear().
  \sa clear()
*/

What could be more simple than that?  If they read that, the \sa will
produce a link where they can go read the documentation for the
referenced function.

Nick
--
Nick MacDonald
Nic...@gm...


On 2/17/06, Christoph Bartoschek <bar...@or...> wrote:
> what is the recommended way to document two functions which do the same, =
but
> have different name. For example I have:
>
> Container::remove_all();
> Container::clear();
>
> The function remove_all() is implemented by calling clear(). Now I want t=
o
> express in the documentation that remove_all() is only another name of
> clear() and that it is provided for convenience. What is the best way to =
do
> it? I do not like to repeat the documentation of clear() for remove_all()=
 and
> here we have only a small example.
>
> I tried \overload but this is not the correct way.