libnfc-d

commit 1561b49aa8bdaa960fda5c38568188519e7c365e
parent f2132a86dd5f359e41320cb977ad458a6b8c5911
Author: Dominik Schmidt <dominik@schm1dt.ch>
Date:   Sat, 16 May 2020 15:48:53 +0200

Some more documentation for Device.poll()

Diffstat:
M
src/nfc/package.d
 | 
8
+++++++-

1 file changed, 7 insertions(+), 1 deletion(-)
diff --git a/src/nfc/package.d b/src/nfc/package.d
@@ -319,7 +319,13 @@ class Device{
 	 * 
 	 * Params:
 	 * 	modulations	= an array of modulations to try
-	 * 	t = The first found target
+	 * 	t           = The first found target
+	 * 	polling     = specifies the number of polling (0x01 - 0xFE: 1 up to 254
+	 * 		polling, 0xFF: Endless polling) 
+	 * 	period      = indicates the polling period, 150ms - 2.25s
+	 * 
+	 * Returns:
+	 * Polled targets count
 	 */
 	int poll(nfc_modulation[] modulations, out Target t, ubyte polling=0xFF, Duration period=dur!"seconds"(1)){
 		auto period_byte = period.total!"msecs"/150;