I have two C/C++ DLLs with the same API that I want to document using
Doxygen. I have grouped the documentation so that each DLL is a module.
Below is a simplified version of the code I am using:
DLL_A.h
///
/// @defgroup api_c_cpp_dlla DLL A
/// @ingroup api_c_cpp
/// @{
///
#ifdef __cplusplus
extern "C"
{
#endif
/// <summary>
/// Connects the client to the server.
/// </summary>
/// <remarks>
/// DLL_A
/// </remarks>
/// Name of the server.
/// Port used by the server.
/// <returns>1 if the operation succeeded otherwise 0.</returns>
int Connect(char* hostname, unsigned short port);
// The rest of the API is omitted.
#ifdef __cplusplus
}
#endif
///
/// @}
///
DLL_B.h
///
/// @defgroup api_c_cpp_dllb DLL B
/// @ingroup api_c_cpp
/// @{
///
#ifdef __cplusplus
extern "C"
{
#endif
/// <summary>
/// Connects the client to the server.
/// </summary>
/// <remarks>
/// DLL_B
/// </remarks>
/// Name of the server.
/// Port used by the server.
/// <returns>1 if the operation succeeded otherwise 0.</returns>
int Connect(char* hostname, unsigned short port);
// The rest of the API is omitted.
#ifdef __cplusplus
}
#endif
///
/// @}
///
The documentation for DLL_A is as expected but for DLL_B all the
documentation is duplicated, it shows the information I entered for both
DLL_A and DLL_B. I guess I am having a problem similar to this
<http://stackoverflow.com/questions/8334081/how-to-document-enumeration-values-with-same-name-with-doxygen>
but the answer is inadequate and old so I was thinking there is another way
around this? How can I make it so that DLL_B only takes information from the
api_c_cpp_dllb group?
--
View this message in context:
http://doxygen.10944.n7.nabble.com/Same-function-names-in-Doxygen-tp7131.html
Sent from the Doxygen - Users mailing list archive at Nabble.com.
------------------------------------------------------------------------------
BPM Camp - Free Virtual Workshop May 6th at 10am PDT/1PM EDT
Develop your own process in accordance with the BPMN 2 standard
Learn Process modeling best practices with Bonita BPM through live exercises
http://www.bonitasoft.com/be-part-of-it/events/bpm-camp-virtual- event?utm_
source=Sourceforge_BPM_Camp_5_6_15&utm_medium=email&utm_campaign=VA_SF
_______________________________________________
Doxygen-users mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/doxygen-users
