Minor documentation fixes.

Add extra parenthesis around terms in the common MIN() and MAX() macros to prevent issues with non-trivial macro inputs (thanks to David Lyons).
This commit is contained in:
Dean Camera 2011-08-23 10:39:04 +00:00
parent 2d9f98b592
commit cff190b8f4
7 changed files with 25 additions and 13 deletions

View file

@ -114,6 +114,9 @@ uint8_t Endpoint_Null_Stream(uint16_t Length,
return ENDPOINT_RWSTREAM_NoError;
}
/* The following abuses the C preprocessor in order to copy-paste common code with slight alterations,
* so that the code needs to be written once. It is a crude form of templating to reduce code maintenance. */
#define TEMPLATE_FUNC_NAME Endpoint_Write_Stream_LE
#define TEMPLATE_BUFFER_TYPE const void*
#define TEMPLATE_CLEAR_ENDPOINT() Endpoint_ClearIN()

View file

@ -119,7 +119,7 @@ uint8_t Pipe_Null_Stream(uint16_t Length,
return PIPE_RWSTREAM_NoError;
}
/* The following abuses the C preprocessor in order to copy-past common code with slight alterations,
/* The following abuses the C preprocessor in order to copy-paste common code with slight alterations,
* so that the code needs to be written once. It is a crude form of templating to reduce code maintenance. */
#define TEMPLATE_FUNC_NAME Pipe_Write_Stream_LE

View file

@ -114,6 +114,9 @@ uint8_t Endpoint_Null_Stream(uint16_t Length,
return ENDPOINT_RWSTREAM_NoError;
}
/* The following abuses the C preprocessor in order to copy-paste common code with slight alterations,
* so that the code needs to be written once. It is a crude form of templating to reduce code maintenance. */
#define TEMPLATE_FUNC_NAME Endpoint_Write_Stream_LE
#define TEMPLATE_BUFFER_TYPE const void*
#define TEMPLATE_CLEAR_ENDPOINT() Endpoint_ClearIN()

View file

@ -119,7 +119,7 @@ uint8_t Pipe_Null_Stream(uint16_t Length,
return PIPE_RWSTREAM_NoError;
}
/* The following abuses the C preprocessor in order to copy-past common code with slight alterations,
/* The following abuses the C preprocessor in order to copy-paste common code with slight alterations,
* so that the code needs to be written once. It is a crude form of templating to reduce code maintenance. */
#define TEMPLATE_FUNC_NAME Pipe_Write_Stream_LE

View file

@ -114,6 +114,9 @@ uint8_t Endpoint_Null_Stream(uint16_t Length,
return ENDPOINT_RWSTREAM_NoError;
}
/* The following abuses the C preprocessor in order to copy-paste common code with slight alterations,
* so that the code needs to be written once. It is a crude form of templating to reduce code maintenance. */
#define TEMPLATE_FUNC_NAME Endpoint_Write_Stream_LE
#define TEMPLATE_BUFFER_TYPE const void*
#define TEMPLATE_CLEAR_ENDPOINT() Endpoint_ClearIN()