On Thu, Jan 29, 2015 at 11:21 AM, <
doxygen-users-requ...@lists.sourceforge.net> wrote:
>
> Date: Thu, 29 Jan 2015 17:21:08 +0100
> From: Fabian Cenedese <cened...@indel.ch>
> Subject: [Doxygen-users] Multiple functions with same name
>
> I'm developing a C-project where I have basically the same code for several
> variants of controllers. A few functions need to be adjusted and are placed
> in separate files. The interface of course is for all the same. For linking
> only the necessary files will be linked in. I don't want to create a
> separate
> documentation for every controller where only little details change. But
> documenting all files will lead to merged documentation of the functions
> with the same name.
>
> Little example:
>
> /* interface */
> a.h
> void DoA(void);
>
> /* implementation ctrl 1 */
> a1.c
> void DoA(void) {
> }
>
> /* implementation ctrl 2 */
> a2.c
> void DoA(void) {
> }
>
Assuming the main part of the function documentation is located in the .h
file, perhaps in the .c files use named paragraphs to "delimit" the
implementation specific details. Something like:
/** @par Ctrl 1 Implementation
Details about ctrl 1 implementation
*/
and similar for the other implementation specific function definitions.
------------------------------------------------------------------------------
Dive into the World of Parallel Programming. The Go Parallel Website,
sponsored by Intel and developed in partnership with Slashdot Media, is your
hub for all things parallel software development, from weekly thought
leadership blogs to news, videos, case studies, tutorials and more. Take a
look and join the conversation now. http://goparallel.sourceforge.net/
_______________________________________________
Doxygen-users mailing list
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
