aboutsummaryrefslogtreecommitdiffstats
path: root/LUFA/Drivers/USB/Core
diff options
context:
space:
mode:
authorDean Camera <dean@fourwalledcubicle.com>2011-08-23 10:39:04 +0000
committerDean Camera <dean@fourwalledcubicle.com>2011-08-23 10:39:04 +0000
commitcff190b8f47416698f3783e1e7711f0864713f73 (patch)
tree8407b1a1e71021bca28abd4784804251733f4ed5 /LUFA/Drivers/USB/Core
parent2d9f98b592c41a0b79eb6d15122fc00f4f91c836 (diff)
downloadlufa-cff190b8f47416698f3783e1e7711f0864713f73.tar.gz
lufa-cff190b8f47416698f3783e1e7711f0864713f73.tar.bz2
lufa-cff190b8f47416698f3783e1e7711f0864713f73.zip
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).
Diffstat (limited to 'LUFA/Drivers/USB/Core')
-rw-r--r--LUFA/Drivers/USB/Core/AVR8/EndpointStream_AVR8.c3
-rw-r--r--LUFA/Drivers/USB/Core/AVR8/PipeStream_AVR8.c2
-rw-r--r--LUFA/Drivers/USB/Core/UC3/EndpointStream_UC3.c3
-rw-r--r--LUFA/Drivers/USB/Core/UC3/PipeStream_UC3.c2
-rw-r--r--LUFA/Drivers/USB/Core/XMEGA/EndpointStream_XMEGA.c3
5 files changed, 11 insertions, 2 deletions
diff --git a/LUFA/Drivers/USB/Core/AVR8/EndpointStream_AVR8.c b/LUFA/Drivers/USB/Core/AVR8/EndpointStream_AVR8.c
index 6682dc062..09907596b 100644
--- a/LUFA/Drivers/USB/Core/AVR8/EndpointStream_AVR8.c
+++ b/LUFA/Drivers/USB/Core/AVR8/EndpointStream_AVR8.c
@@ -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()
diff --git a/LUFA/Drivers/USB/Core/AVR8/PipeStream_AVR8.c b/LUFA/Drivers/USB/Core/AVR8/PipeStream_AVR8.c
index b3d263c83..7b762837c 100644
--- a/LUFA/Drivers/USB/Core/AVR8/PipeStream_AVR8.c
+++ b/LUFA/Drivers/USB/Core/AVR8/PipeStream_AVR8.c
@@ -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
diff --git a/LUFA/Drivers/USB/Core/UC3/EndpointStream_UC3.c b/LUFA/Drivers/USB/Core/UC3/EndpointStream_UC3.c
index 98d3ac04c..143708772 100644
--- a/LUFA/Drivers/USB/Core/UC3/EndpointStream_UC3.c
+++ b/LUFA/Drivers/USB/Core/UC3/EndpointStream_UC3.c
@@ -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()
diff --git a/LUFA/Drivers/USB/Core/UC3/PipeStream_UC3.c b/LUFA/Drivers/USB/Core/UC3/PipeStream_UC3.c
index 3aa815c98..3b8267ac6 100644
--- a/LUFA/Drivers/USB/Core/UC3/PipeStream_UC3.c
+++ b/LUFA/Drivers/USB/Core/UC3/PipeStream_UC3.c
@@ -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
diff --git a/LUFA/Drivers/USB/Core/XMEGA/EndpointStream_XMEGA.c b/LUFA/Drivers/USB/Core/XMEGA/EndpointStream_XMEGA.c
index b1b05bfaa..15ee479cb 100644
--- a/LUFA/Drivers/USB/Core/XMEGA/EndpointStream_XMEGA.c
+++ b/LUFA/Drivers/USB/Core/XMEGA/EndpointStream_XMEGA.c
@@ -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()