From e0c85c72cce8ec722adea46f31a83e43d5983a98 Mon Sep 17 00:00:00 2001 From: Javier Godoy <11554739+javier-godoy@users.noreply.github.com> Date: Wed, 29 Apr 2026 14:12:44 -0300 Subject: [PATCH] docs(code-style): clarify that member links are allowed --- code-style.md | 10 ++++++++-- 1 file changed, 8 insertions(+), 2 deletions(-) diff --git a/code-style.md b/code-style.md index cb8a8f0..f3dcac4 100644 --- a/code-style.md +++ b/code-style.md @@ -76,11 +76,17 @@ The following identifiers must never be linked and should always be wrapped in ` - Exceptions listed in the throws` clause of the documented method. - The names of the direct supertype and any implemented interfaces of the documented type (in a type-level comment). +The restriction about which identifiers must never be linked applies only to the type identifier itself. `{@link}` must still be used for the first reference to specific methods or fields belonging to those restricted types. + ``` /** - * Creates a new instance of {@code FooBar}. + * Wraps a {@code Bar} into a new {@code Foo} container. + *

The internal name is derived via {@link Bar#getName()}. + * If {@code Bar#getName()} returns {@code null}, then the internal name is randomized. + * + * @param bar the {@code Bar} instance to be wrapped */ - public FooBar() { ... } + public Foo(Bar bar) { ... } ``` #### Deprecation