embed.fnc: Add some comments

khwilliamson · khwilliamson · commit 4a81385c2b7e · 2025-08-19T18:12:02.000-06:00
diff --git a/embed.fnc b/embed.fnc
@@ -42,7 +42,11 @@
 : comments here mostly don't include how Devel::PPPort or diag.t use them:
 : All the possible flags and their meanings are given below.
 :
-: A function taking no parameters will have no 'arg' elements.
+: A function taking no parameters will have no 'arg' elements.  Currently
+: arguments that are function pointers are unlikely to be parsed properly here
+: (patches welcome!); you can work around this by creating a typedef for the
+: function pointer, in an appropriate header file and using that here.
+:
 : A line may be continued onto the next by ending it with a backslash.
 : Leading and trailing whitespace will be ignored in each component.
 :
@@ -112,6 +116,8 @@
 :         perlintern.  If no documentation exists, that fact is also noted in
 :         perlintern.
 :
+:	  Use the 'X' flag instead to suppress the short name outside the core
+:
 :         These require one of the /[iIpS]/ flags to give callers a name to use
 :         that won't possibly collide with their own
 :

Original file line number	Diff line number	Diff line change
`@@ -42,7 +42,11 @@`
`42`	`42`	`: comments here mostly don't include how Devel::PPPort or diag.t use them:`
`43`	`43`	`: All the possible flags and their meanings are given below.`
`44`	`44`	`:`
`45`		`-: A function taking no parameters will have no 'arg' elements.`
	`45`	`+: A function taking no parameters will have no 'arg' elements. Currently`
	`46`	`+: arguments that are function pointers are unlikely to be parsed properly here`
	`47`	`+: (patches welcome!); you can work around this by creating a typedef for the`
	`48`	`+: function pointer, in an appropriate header file and using that here.`
	`49`	`+:`
`46`	`50`	`: A line may be continued onto the next by ending it with a backslash.`
`47`	`51`	`: Leading and trailing whitespace will be ignored in each component.`
`48`	`52`	`:`
`@@ -112,6 +116,8 @@`
`112`	`116`	`: perlintern. If no documentation exists, that fact is also noted in`
`113`	`117`	`: perlintern.`
`114`	`118`	`:`
	`119`	`+: Use the 'X' flag instead to suppress the short name outside the core`
	`120`	`+:`
`115`	`121`	`: These require one of the /[iIpS]/ flags to give callers a name to use`
`116`	`122`	`: that won't possibly collide with their own`
`117`	`123`	`:`