Polish SpEL documentation

sbrannen · Nov 18, 2024 · 7196f3f · 7196f3f
1 parent a12d40e
commit 7196f3f
Show file tree

Hide file tree

Showing 6 changed files with 25 additions and 16 deletions.
diff --git a/framework-docs/modules/ROOT/pages/core/expressions/language-ref/constructors.adoc b/framework-docs/modules/ROOT/pages/core/expressions/language-ref/constructors.adoc
@@ -12,12 +12,12 @@ Java::
 +
 [source,java,indent=0,subs="verbatim,quotes"]
 ----
-	Inventor einstein = p.parseExpression(
-			"new org.spring.samples.spel.inventor.Inventor('Albert Einstein', 'German')")
+	Inventor einstein = parser.parseExpression(
+		"new org.spring.samples.spel.inventor.Inventor('Albert Einstein', 'German')")
 			.getValue(Inventor.class);
 
 	// create new Inventor instance within the add() method of List
-	p.parseExpression(
+	parser.parseExpression(
 		"Members.add(new org.spring.samples.spel.inventor.Inventor('Albert Einstein', 'German'))")
 			.getValue(societyContext);
 ----
@@ -26,13 +26,13 @@ Kotlin::
 +
 [source,kotlin,indent=0,subs="verbatim,quotes"]
 ----
-	val einstein = p.parseExpression(
-			"new org.spring.samples.spel.inventor.Inventor('Albert Einstein', 'German')")
+	val einstein = parser.parseExpression(
+		"new org.spring.samples.spel.inventor.Inventor('Albert Einstein', 'German')")
 			.getValue(Inventor::class.java)
 
 	// create new Inventor instance within the add() method of List
-	p.parseExpression(
-			"Members.add(new org.spring.samples.spel.inventor.Inventor('Albert Einstein', 'German'))")
+	parser.parseExpression(
+		"Members.add(new org.spring.samples.spel.inventor.Inventor('Albert Einstein', 'German'))")
 			.getValue(societyContext)
 ----
 ======

diff --git a/framework-docs/modules/ROOT/pages/core/expressions/language-ref/functions.adoc b/framework-docs/modules/ROOT/pages/core/expressions/language-ref/functions.adoc
@@ -151,10 +151,10 @@ Kotlin::
 ----
 ======
 
-As hinted above, binding a `MethodHandle` and registering the bound `MethodHandle` is also
-supported. This is likely to be more performant if both the target and all the arguments
-are bound. In that case no arguments are necessary in the SpEL expression, as the
-following example shows:
+As mentioned above, binding a `MethodHandle` and registering the bound `MethodHandle` is
+also supported. This is likely to be more performant if both the target and all the
+arguments are bound. In that case no arguments are necessary in the SpEL expression, as
+the following example shows:
 
 [tabs]
 ======
@@ -168,9 +168,10 @@ Java::
 	String template = "This is a %s message with %s words: <%s>";
 	Object varargs = new Object[] { "prerecorded", 3, "Oh Hello World!", "ignored" };
 	MethodHandle mh = MethodHandles.lookup().findVirtual(String.class, "formatted",
-			MethodType.methodType(String.class, Object[].class))
+		MethodType.methodType(String.class, Object[].class))
 			.bindTo(template)
-			.bindTo(varargs); //here we have to provide arguments in a single array binding
+			// Here we have to provide the arguments in a single array binding:
+			.bindTo(varargs);
 	context.setVariable("message", mh);
 
 	// evaluates to "This is a prerecorded message with 3 words: <Oh Hello World!>"
@@ -189,9 +190,10 @@ Kotlin::
 	val varargs = arrayOf("prerecorded", 3, "Oh Hello World!", "ignored")
 
 	val mh = MethodHandles.lookup().findVirtual(String::class.java, "formatted",
-			MethodType.methodType(String::class.java, Array<Any>::class.java))
+		MethodType.methodType(String::class.java, Array<Any>::class.java))
 			.bindTo(template)
-			.bindTo(varargs) //here we have to provide arguments in a single array binding
+			// Here we have to provide the arguments in a single array binding:
+			.bindTo(varargs)
 	context.setVariable("message", mh)
 
 	// evaluates to "This is a prerecorded message with 3 words: <Oh Hello World!>"

diff --git a/...ression/src/test/java/org/springframework/expression/spel/ConstructorInvocationTests.java b/...ression/src/test/java/org/springframework/expression/spel/ConstructorInvocationTests.java
@@ -36,6 +36,8 @@
  * Tests invocation of constructors.
  *
  * @author Andy Clement
+ * @see MethodInvocationTests
+ * @see VariableAndFunctionTests
  */
 class ConstructorInvocationTests extends AbstractExpressionTests {
 

diff --git a/...g-expression/src/test/java/org/springframework/expression/spel/MethodInvocationTests.java b/...g-expression/src/test/java/org/springframework/expression/spel/MethodInvocationTests.java
@@ -48,6 +48,8 @@
  * @author Andy Clement
  * @author Phillip Webb
  * @author Sam Brannen
+ * @see ConstructorInvocationTests
+ * @see VariableAndFunctionTests
  */
 class MethodInvocationTests extends AbstractExpressionTests {
 

diff --git a/...-expression/src/test/java/org/springframework/expression/spel/SpelDocumentationTests.java b/...-expression/src/test/java/org/springframework/expression/spel/SpelDocumentationTests.java
@@ -658,7 +658,8 @@ void registerFunctionViaMethodHandleFullyBound() throws Exception {
 			MethodHandle methodHandle = MethodHandles.lookup().findVirtual(String.class, "formatted",
 				MethodType.methodType(String.class, Object[].class))
 					.bindTo(template)
-					.bindTo(varargs); // here we have to provide arguments in a single array binding
+					// Here we have to provide the arguments in a single array binding:
+					.bindTo(varargs);
 			context.registerFunction("message", methodHandle);
 
 			String message = parser.parseExpression("#message()").getValue(context, String.class);

diff --git a/...xpression/src/test/java/org/springframework/expression/spel/VariableAndFunctionTests.java b/...xpression/src/test/java/org/springframework/expression/spel/VariableAndFunctionTests.java
@@ -32,6 +32,8 @@
  *
  * @author Andy Clement
  * @author Sam Brannen
+ * @see ConstructorInvocationTests
+ * @see MethodInvocationTests
  */
 class VariableAndFunctionTests extends AbstractExpressionTests {