Merge pull request #2 from Gerrit0/patch-1

Update inheritdoc.md
This commit is contained in:
Pete Gonzalez 2021-05-14 10:54:07 -07:00 коммит произвёл GitHub
Родитель 832546ce9f 6a961532d2
Коммит 969293ad77
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 4AEE18F83AFDEB23
2 изменённых файлов: 13 добавлений и 6 удалений

Просмотреть файл

@ -78,13 +78,19 @@ by `{` and `}` characters. The `@link` and `@inheritDoc` tags are examples of i
```ts
class Book {
/**
* Saves the book to the database.
* Writes the book information into a JSON file.
*
* @remarks
* {@inheritDoc example-library#Serializer.writeFile}
*
* @deprecated
* Use {@link example-library#Serializer.writeFile} instead of this method.
* This method saves the book information to a JSON file conforming to the standardized
* {@link http://example.com/ | Example Book Interchange Format}.
*/
public writeFile(options?: IWriteFileOptions): void {
. . .
}
/**
* {@inheritDoc Book.writeFile}
* @deprecated Use {@link Book.writeFile} instead.
*/
public save(): void {
. . .

Просмотреть файл

@ -29,7 +29,8 @@ The `@inheritDoc` tag does not copy the entire comment body. Only the following
- `@returns` block
Other tags such as `@defaultValue` or `@example` are not copied, and need to be explicitly included after
the `@inheritDoc` tag.
the `@inheritDoc` tag. When the `@inheritDoc` tag is specified, neither the summary section nor the `@remarks`
section may be specified in the comment.
## Example