Re: [Doxygen-users] Another question....

2015-09-05 Thread Jeremy Royston
The easiest way to avoid this problem ist to copy the header in the .c file and paste it at the end of the .h file. You don't have to type anything except the ";", so it's almost no work either. Jerry --

Re: [Doxygen-users] Another question....

2015-09-04 Thread woody
in it. From: woody [mailto:knap...@realtime.net] Sent: Friday, September 04, 2015 10:55 AM To: Frank Peelo; doxygen-users@lists.sourceforge.net Subject: Re: [Doxygen-users] Another question At 09:00 AM 9/4/2015 +0100, Frank Peelo wrote: If you're really going to have different parameter

Re: [Doxygen-users] Another question....

2015-09-04 Thread Brian Henning
of a function ought to be looking at the prototype, not the definition, so if anything, the prototype ought to have the more appropriate names. From: woody [mailto:knap...@realtime.net] Sent: Friday, September 04, 2015 10:55 AM To: Frank Peelo; doxygen-users@lists.sourceforge.net Subject: Re

Re: [Doxygen-users] Another question....

2015-09-04 Thread woody
At 09:00 AM 9/4/2015 +0100, Frank Peelo wrote: If you're really going to have different parameter names, the ones in the header should be the ones documented. The documentation is for people who are going to use the function; Precisely, that is why it should be the FUNCTION ACTUAL HEADER the

Re: [Doxygen-users] Another question....

2015-09-04 Thread Frank Peelo
If you're really going to have different parameter names, the ones in the header should be the ones documented. The documentation is for people who are going to use the function; the people working on the function body can read the code. People using the function can see the .h file, which has

[Doxygen-users] Another question....

2015-09-03 Thread woody
It seems that Doxygen uses the prototype definition when it creates documentation for a function in the html and rtf files. For example, The actual definition of initiate_beep static void initiate_beep (int duration,int off, char count) { // code body } the prototype: static void initiate_beep