vy commented on code in PR #3877:
URL: https://github.com/apache/logging-log4j2/pull/3877#discussion_r2286208874
##########
log4j-plugins/src/main/java/org/apache/logging/log4j/plugins/NameProvider.java:
##########
@@ -14,18 +14,20 @@
* See the License for the specific language governing permissions and
* limitations under the License.
*/
-package org.apache.logging.log4j.plugins.name;
+package org.apache.logging.log4j.plugins;
-import java.lang.annotation.Annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
+/**
+ * Marks another annotation as one providing a name for an object. The name is
obtained from
+ * the annotation element named {@code value}. This element can be a {@code
String} or {@code String[]}.
+ * When specified as an array, the first element is used.
+ */
Review Comment:
Right! Got it!
```suggestion
/**
* Marks another annotation as one providing a name for an object.
* The name is obtained from the annotation element named {@code value}.
* This element can be a {@code String} or {@code String[]}.
* When specified as an array, the first element is used.
* <h2>Examples:</h2>
* <ul>
* <li>{@code @NameProvider @Named(String value)} - {@code value} will be
used as the name
* <li>{@code @NameProvider @PluginAliases(String[] value)} - {@code
value[0]} will be used as the name
* </ul>
*/
```
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: notifications-unsubscr...@logging.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
