diff --git a/docs/docs/model.md b/docs/docs/model.md index 55e18319f1e..77377594e6e 100644 --- a/docs/docs/model.md +++ b/docs/docs/model.md @@ -442,7 +442,12 @@ class MyController { ### LabelledAs The @@LabelledAs@@ decorator is used to set a label to decorated property. -This label will be used to generate a reference for the schema related to the decorated property. + +This label will be used to generate a reference for the schema related to the decorated property. This is particularly useful when: + +- You want to create reusable schema components +- You need to maintain consistent schema references across your API +- You want to improve the readability of your generated swagger.json ```typescript import {LabelledAs} from "@tsed/schema"; diff --git a/tsdoc.config.js b/tsdoc.config.js index cb957bd48e8..05b71a2de03 100644 --- a/tsdoc.config.js +++ b/tsdoc.config.js @@ -17,7 +17,7 @@ module.exports = { "!/packages/**/constants", "!/packages/**/registries", "!/packages/**/lib/**/hooks", - "!/packages/**/utils", + "!/packages/{di,engines,orm,perf,platform,security,specs,third-parties}/**/utils", "!/packages/perf", "!/packages/orm/prisma", "!/packages/third-parties/components-scan",