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

[Michael K. <mko...@la...>]

> what is the recommended way to document two functions which do the same, but 
> have different name. For example I have:
>   
Try using the \copydoc command.  It works for me.  Basically, you will 
put documentation above remove_all to look something like this:

/**
  \copydoc Container::clear()
*/
Container::remove_all();


Note also that you can add additional documentation specific only to the 
member that you are copying to.  What I mean is something like this:

/**
  \copydoc Container::clear()

  This will only show up in remove_all() and not clear().  By the way, 
this function in just
  another name for clear() and only here for convenience.
*/
Container::remove_all();

I hope this helps you out!

Michael


> 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
>
>
> -------------------------------------------------------
> This SF.net email is sponsored by: Splunk Inc. Do you grep through log files
> for problems?  Stop!  Download the new AJAX search engine that makes
> searching your log files as easy as surfing the  web.  DOWNLOAD SPLUNK!
> http://sel.as-us.falkag.net/sel?cmd=lnk&kid=103432&bid=230486&dat=121642
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>