@param tag

This tag starts a function or macro parameter documentation. Parameters list will be put where the first @param tag appears. If there is no text before this tag in the current paragraph, a "Parameters list:" line will be inserted before the list.

Parameter description ends on next paragraph boundary and does not need an @end tag. Paragraph boundaries occur on empty lines or on non inline tags.

Syntax  

@param <parameter name> <description>
...
[ @param <parameter name> <description> ]
<end of comment or empty line>

Examples  

These declarations:

/**
This function copies some bytes in memory.

@param dest Destination memory buffer.
@param src Source memory buffer.
@param n Number of bytes to copy.

The source and the destination buffers must not overlap .
*/

void *memcpy(void *dest, const void *src, size_t n);

/**
This function moves some bytes in memory, it requires
the following parameters:
@param dest Destination memory buffer.
@param src Source memory buffer.
May overlap with destination.
@param n Number of bytes to copy.
*/

void *memmove(void *dest, const void *src, size_t n);

generates the following member details:

void * memcpy(void *dest, const void *src, size_t n)  

This function is declared in doc/examples.h source file, line 95.

This function copies some bytes in memory.

Parameters list:

  • dest: Destination memory buffer.
  • src: Source memory buffer.
  • n: Number of bytes to copy.

The source and the destination buffers must not overlap .

void * memmove(void *dest, const void *src, size_t n)  

This function is declared in doc/examples.h source file, line 105.

This function moves some bytes in memory, it requires the following parameters:

  • dest: Destination memory buffer.
  • src: Source memory buffer. May overlap with destination.
  • n: Number of bytes to copy.

Valid XHTML 1.0 StrictGenerated by diaxen on Sun Jan 8 22:43:00 2012 using MkDoc