Skip to content

Commit e67e502

Browse files
committed
embed.fnc: Clarify a few comments
1 parent 0e943ce commit e67e502

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

embed.fnc

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -195,7 +195,7 @@
195195
: NULLOK means the called function definitely can handle this parameter
196196
: being NULL. The reason you need to specify this at all is to tell
197197
: future maintainers that you have considered the question about the
198-
: parameter, and this is the answer.
198+
: parameter, and you have determined that this is the answer.
199199
: SPTR means that not only must this pointer parameter be non-NULL, it
200200
: points to a position in a character string, which the called
201201
: function is not to look behind. If a parameter is marked with this
@@ -226,14 +226,14 @@
226226
: In each equation all three or any two of the constraints must be present.
227227
:
228228
: When only two constraints are present and one of them is either EPTR or
229-
: EPTRQ, the difference between the remaining SPTR or MPTR becomes somewhat
230-
: fuzzy; the generated assertion will be the same whichever constraint is
231-
: used. You should choose the one that makes the most sense for the
232-
: semantics of the parameter. For example, there are currently some
233-
: functions with parameters named 'curpos', and no SPTR parameter exists.
234-
: The name of the parameter clearly indicates it isn't necessarily the
235-
: starting position of the string, so using MPTR as the constraint makes the
236-
: most sense.
229+
: EPTRQ, the difference between your choosing to use SPTR or MPTR for the
230+
: other one becomes somewhat fuzzy; the generated assertion will be the same
231+
: whichever constraint is used. You should choose the one that makes the
232+
: most sense for the semantics of the parameter. For example, there are
233+
: currently some functions with parameters named 'curpos', and no SPTR
234+
: parameter exists. The name of the parameter clearly indicates it isn't
235+
: necessarily the starting position of the string, so using MPTR as the
236+
: constraint makes the most sense.
237237
:
238238
: The parameters for the function can be in any order, except if a function
239239
: has multiple different character strings, all the parameters for the first

0 commit comments

Comments
 (0)