Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
12 changes: 9 additions & 3 deletions code-style.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Flowing Code Style Guide / 1.0.4
# Flowing Code Style Guide / 1.0.5

In any file format, maintain a consistent style for indentation and alignment throughout the entire file. Do not use tab characters on some lines and a fixed amount of whitespace on others, as their display can differ across devices and platforms.

Expand Down Expand Up @@ -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.
* <p>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
Expand Down