From 0ff6640661d48aaac30e06a82d93dd9395369877 Mon Sep 17 00:00:00 2001 From: Gerrit Birkeland Date: Sat, 16 Jan 2021 09:16:53 -0700 Subject: [PATCH] Update inheritdoc.md --- pages/tags/inheritdoc.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/pages/tags/inheritdoc.md b/pages/tags/inheritdoc.md index a7a5c1f..3964596 100644 --- a/pages/tags/inheritdoc.md +++ b/pages/tags/inheritdoc.md @@ -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