Skip to content

Commit

Permalink
Update guide-chapter-2.md
Browse files Browse the repository at this point in the history
Fixing small issues
  • Loading branch information
orchestr7 authored Dec 3, 2020
1 parent 4ca8322 commit 123e9d4
Showing 1 changed file with 1 addition and 3 deletions.
4 changes: 1 addition & 3 deletions info/guide/guide-chapter-2.md
Original file line number Diff line number Diff line change
Expand Up @@ -82,8 +82,6 @@ fun isEmptyList(list: List<String>) = list.size == 0
```

Note: You can skip KDocs for a method's override if it is almost the same as the superclass method.
### <a name="r2.1.2"></a>Rule 2.1.2: Describing methods with arguments, return value or can throw exceptions
When the method has arguments, return value, or can throw exceptions, it must be described in the KDoc block: with @param, @return, @throws

### <a name="r2.1.2"></a>Rule 2.1.2: When the method has arguments, return value, can throw exceptions, etc., it must be described in the KDoc block: with @param, @return, @throws, etc.

Expand Down Expand Up @@ -309,4 +307,4 @@ They should all have a unified style to facilitate the unified text search proce
// FIXME: Jira-XXX - fix NPE in this code block
```

At a version development stage, these annotations can be used to highlight the issues in the code, but all of them should be fixed before a new product version is released.
At a version development stage, these annotations can be used to highlight the issues in the code, but all of them should be fixed before a new product version is released.

0 comments on commit 123e9d4

Please sign in to comment.