Skip to content

Commit ca2f80a

Browse files
committed
Add links to the documentation
1 parent f17fc05 commit ca2f80a

File tree

1 file changed

+20
-1
lines changed

1 file changed

+20
-1
lines changed

src/ArduinoJson/Configuration.hpp

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
#pragma once
66

77
// Support std::istream and std::ostream
8+
// https://arduinojson.org/v7/config/enable_std_stream/
89
#ifndef ARDUINOJSON_ENABLE_STD_STREAM
910
# ifdef __has_include
1011
# if __has_include(<istream>) && \
@@ -25,6 +26,7 @@
2526
#endif
2627

2728
// Support std::string
29+
// https://arduinojson.org/v7/config/enable_std_string/
2830
#ifndef ARDUINOJSON_ENABLE_STD_STRING
2931
# ifdef __has_include
3032
# if __has_include(<string>) && !defined(min) && !defined(max)
@@ -55,6 +57,7 @@
5557
#endif
5658

5759
// Store floating-point values with float (0) or double (1)
60+
// https://arduinojson.org/v7/config/use_double/
5861
#ifndef ARDUINOJSON_USE_DOUBLE
5962
# define ARDUINOJSON_USE_DOUBLE 1
6063
#endif
@@ -71,6 +74,7 @@
7174
#endif
7275

7376
// Store integral values with long (0) or long long (1)
77+
// https://arduinojson.org/v7/config/use_long_long/
7478
#ifndef ARDUINOJSON_USE_LONG_LONG
7579
# if ARDUINOJSON_SIZEOF_POINTER >= 4 // 32 & 64 bits systems
7680
# define ARDUINOJSON_USE_LONG_LONG 1
@@ -80,11 +84,13 @@
8084
#endif
8185

8286
// Limit nesting as the stack is likely to be small
87+
// https://arduinojson.org/v7/config/default_nesting_limit/
8388
#ifndef ARDUINOJSON_DEFAULT_NESTING_LIMIT
8489
# define ARDUINOJSON_DEFAULT_NESTING_LIMIT 10
8590
#endif
8691

87-
// Number of bytes to store the variant identifier
92+
// Number of bytes to store a slot id
93+
// https://arduinojson.org/v7/config/slot_id_size/
8894
#ifndef ARDUINOJSON_SLOT_ID_SIZE
8995
# if ARDUINOJSON_SIZEOF_POINTER <= 2
9096
# define ARDUINOJSON_SLOT_ID_SIZE 1 // up to 255 slots
@@ -123,6 +129,7 @@
123129
#endif
124130

125131
// Number of bytes to store the length of a string
132+
// https://arduinojson.org/v7/config/string_length_size/
126133
#ifndef ARDUINOJSON_STRING_LENGTH_SIZE
127134
# if ARDUINOJSON_SIZEOF_POINTER <= 2
128135
# define ARDUINOJSON_STRING_LENGTH_SIZE 1 // up to 255 characters
@@ -134,11 +141,13 @@
134141
#ifdef ARDUINO
135142

136143
// Enable support for Arduino's String class
144+
// https://arduinojson.org/v7/config/enable_arduino_string/
137145
# ifndef ARDUINOJSON_ENABLE_ARDUINO_STRING
138146
# define ARDUINOJSON_ENABLE_ARDUINO_STRING 1
139147
# endif
140148

141149
// Enable support for Arduino's Stream class
150+
// https://arduinojson.org/v7/config/enable_arduino_stream/
142151
# ifndef ARDUINOJSON_ENABLE_ARDUINO_STREAM
143152
# define ARDUINOJSON_ENABLE_ARDUINO_STREAM 1
144153
# endif
@@ -149,18 +158,21 @@
149158
# endif
150159

151160
// Enable support for PROGMEM
161+
// https://arduinojson.org/v7/config/enable_progmem/
152162
# ifndef ARDUINOJSON_ENABLE_PROGMEM
153163
# define ARDUINOJSON_ENABLE_PROGMEM 1
154164
# endif
155165

156166
#else // ARDUINO
157167

158168
// Disable support for Arduino's String class
169+
// https://arduinojson.org/v7/config/enable_arduino_string/
159170
# ifndef ARDUINOJSON_ENABLE_ARDUINO_STRING
160171
# define ARDUINOJSON_ENABLE_ARDUINO_STRING 0
161172
# endif
162173

163174
// Disable support for Arduino's Stream class
175+
// https://arduinojson.org/v7/config/enable_arduino_stream/
164176
# ifndef ARDUINOJSON_ENABLE_ARDUINO_STREAM
165177
# define ARDUINOJSON_ENABLE_ARDUINO_STREAM 0
166178
# endif
@@ -171,6 +183,7 @@
171183
# endif
172184

173185
// Enable PROGMEM support on AVR only
186+
// https://arduinojson.org/v7/config/enable_progmem/
174187
# ifndef ARDUINOJSON_ENABLE_PROGMEM
175188
# ifdef __AVR__
176189
# define ARDUINOJSON_ENABLE_PROGMEM 1
@@ -182,32 +195,38 @@
182195
#endif // ARDUINO
183196

184197
// Convert unicode escape sequence (\u0123) to UTF-8
198+
// https://arduinojson.org/v7/config/decode_unicode/
185199
#ifndef ARDUINOJSON_DECODE_UNICODE
186200
# define ARDUINOJSON_DECODE_UNICODE 1
187201
#endif
188202

189203
// Ignore comments in input
204+
// https://arduinojson.org/v7/config/enable_comments/
190205
#ifndef ARDUINOJSON_ENABLE_COMMENTS
191206
# define ARDUINOJSON_ENABLE_COMMENTS 0
192207
#endif
193208

194209
// Support NaN in JSON
210+
// https://arduinojson.org/v7/config/enable_nan/
195211
#ifndef ARDUINOJSON_ENABLE_NAN
196212
# define ARDUINOJSON_ENABLE_NAN 0
197213
#endif
198214

199215
// Support Infinity in JSON
216+
// https://arduinojson.org/v7/config/enable_infinity/
200217
#ifndef ARDUINOJSON_ENABLE_INFINITY
201218
# define ARDUINOJSON_ENABLE_INFINITY 0
202219
#endif
203220

204221
// Control the exponentiation threshold for big numbers
205222
// CAUTION: cannot be more that 1e9 !!!!
223+
// https://arduinojson.org/v7/config/positive_exponentiation_threshold/
206224
#ifndef ARDUINOJSON_POSITIVE_EXPONENTIATION_THRESHOLD
207225
# define ARDUINOJSON_POSITIVE_EXPONENTIATION_THRESHOLD 1e7
208226
#endif
209227

210228
// Control the exponentiation threshold for small numbers
229+
// https://arduinojson.org/v7/config/negative_exponentiation_threshold/
211230
#ifndef ARDUINOJSON_NEGATIVE_EXPONENTIATION_THRESHOLD
212231
# define ARDUINOJSON_NEGATIVE_EXPONENTIATION_THRESHOLD 1e-5
213232
#endif

0 commit comments

Comments
 (0)