[Doxygen-users] Documenting same functions with different names.
Brought to you by:
dimitri
|
From: Christoph B. <bar...@or...> - 2006-02-17 21:10:42
|
Hi, 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 to 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. Greets Christoph Bartoschek |