From f32375cc1094e85a135185e01de71c352d4ba888 Mon Sep 17 00:00:00 2001 From: Rob Bygrave Date: Mon, 27 Sep 2021 17:36:09 +1300 Subject: [PATCH] Change javadoc Noting that is not valid in html5 and the suggestion is to change it to --- src/main/java/jakarta/inject/Inject.java | 18 +++++++++--------- src/main/java/jakarta/inject/package-info.java | 12 ++++++------ 2 files changed, 15 insertions(+), 15 deletions(-) diff --git a/src/main/java/jakarta/inject/Inject.java b/src/main/java/jakarta/inject/Inject.java index e7dd028..0ea97a2 100644 --- a/src/main/java/jakarta/inject/Inject.java +++ b/src/main/java/jakarta/inject/Inject.java @@ -36,24 +36,24 @@ * zero or more dependencies as arguments. {@code @Inject} can apply to at most * one constructor per class. * - *
@Inject + *
@Inject * ConstructorModifiersopt * SimpleTypeName(FormalParameterListopt) * Throwsopt - * ConstructorBody + * ConstructorBody *
* *

{@code @Inject} is optional for public, no-argument constructors when no * other constructors are present. This enables injectors to invoke default * constructors. * - *

+ *
* {@literal @}Injectopt * Annotationsopt * public * SimpleTypeName() * Throwsopt - * ConstructorBody + * ConstructorBody *
*

Injectable fields: @@ -62,10 +62,10 @@ *

  • are not final. *
  • may have any otherwise valid name.
    • * - *
    @Inject + *
    @Inject * FieldModifiersopt * Type - * VariableDeclarators; + * VariableDeclarators; *
    * *

    Injectable methods: @@ -77,12 +77,12 @@ *

  • may have any otherwise valid name.
    • *
  • accept zero or more dependencies as arguments.
    • * - *
    @Inject + *
    @Inject * MethodModifiersopt * ResultType * Identifier(FormalParameterListopt) * Throwsopt - * MethodBody + * MethodBody *
    * *

    The injector ignores the result of an injected method, but @@ -111,7 +111,7 @@ * *

    Injection of members annotated with {@code @Inject} is required. While an * injectable member may use any accessibility modifier (including - * private), platform or injector limitations (like security + * private), platform or injector limitations (like security * restrictions or lack of reflection support) might preclude injection * of non-public members. * diff --git a/src/main/java/jakarta/inject/package-info.java b/src/main/java/jakarta/inject/package-info.java index 1f7abe2..01f500d 100644 --- a/src/main/java/jakarta/inject/package-info.java +++ b/src/main/java/jakarta/inject/package-info.java @@ -21,8 +21,8 @@ * locators (e.g., JNDI). This process, known as dependency * injection, is beneficial to most nontrivial applications. * - *

    Many types depend on other types. For example, a Stopwatch might - * depend on a TimeSource. The types on which a type depends are + *

    Many types depend on other types. For example, a Stopwatch might + * depend on a TimeSource. The types on which a type depends are * known as its dependencies. The process of finding an instance of a * dependency to use at run time is known as resolving the dependency. * If no such instance can be found, the dependency is said to be @@ -100,7 +100,7 @@ * *

    The injector further passes dependencies to other dependencies until it * constructs the entire object graph. For example, suppose the programmer - * asked an injector to create a StopwatchWidget instance: + * asked an injector to create a StopwatchWidget instance: * * 

       /** GUI for a Stopwatch */
  *   class StopwatchWidget {
@@ -110,9 +110,9 @@
  *
  * 
    The injector might:
  * 
      
- *   
    1. Find a TimeSource
- *   
    2. Construct a Stopwatch with the TimeSource
- *   
    3. Construct a StopwatchWidget with the Stopwatch
+ *   
    4. Find a TimeSource
+ *   
    5. Construct a Stopwatch with the TimeSource
+ *   
    6. Construct a StopwatchWidget with the Stopwatch
  * 
    
  *
  * 
    This leaves the programmer's code clean, flexible, and relatively free