[Doxygen-users] Question on documenting similar (overloaded functions)
Brought to you by:
dimitri
From: <adn...@on...> - 2001-08-29 16:51:30
|
I am trying to document some code and the problem I am having is to group some functions together. For example I am overloading the '=' operator and passing a char*,char and some other different types. Each of these has there own function. For e.g. const DATATYPE operator =(const char *str) ; const DATATYPE operator =(const char ch) ; const DATATYPE operator =(int number) ; Now instead of having three different comment blocks, one for each, I was hoping to group these together so that they come up in the documentation as const DATATYPE operator= const DATATYPE operator =(const char *str) ; const DATATYPE operator =(const char ch) ; const DATATYPE operator =(int number) ; Parameters: char* str , character pointer. char ch, character int number, integer Remarks: This is the overloaded operator. This way, there are not four different functions to click on in the html documentation. I am trying to do this to make it similar to MSDN documentation and easier to read. Thank you for all your help. Adnan. |