Skip to content

Commit

Permalink
Prevent rendering of @preserve tags by TypeDoc
Browse files Browse the repository at this point in the history
These tags are only used during transpilation to note if we need to keep specific comments,
so should not show in the API reference
  • Loading branch information
romaricpascal committed Aug 20, 2024
1 parent 6111ab0 commit b10e362
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion packages/govuk-frontend-review/typedoc.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -59,5 +59,10 @@ module.exports = {
...typedoc.Configuration.OptionDefaults.modifierTags,
'@preserve',
'@constant'
]
],

// We don't want typedoc to render a 'Preserve' tag
// as it's only for controlling which comments get rendered or not
// after transpilation
excludeTags: ['@preserve']
}

0 comments on commit b10e362

Please sign in to comment.