MarkP
MarkP

Reputation: 4278

Doxygen comments for variant C functions with similar signatures

I'm writing a program in C. Due to the language's static typing, Its necessary to duplicate functions in the following way:

void foo_8(uint8_t thingy);
void foo_16(uint16_t thingy);
void foo_32(uint32_t thingy);

When it comes to doxygen comments, you're forced to copy-paste the same comment block several times. Does doxygen have facilities/tags to say "This function is the same as another focuntion"?

Upvotes: 2

Views: 203

Answers (1)

Garf365
Garf365

Reputation: 3707

You can use copydoc, copybrief or copydetails :

  \copydoc foo_8()

or

  \brief \copybrief foo_8()
  \details \copydetails foo_8()

Upvotes: 4

Related Questions