Skip to content

Commit c4918cf

Browse files
Wojciech KrysiakWojciech Krysiak
authored andcommitted
docs: fix error with jsdocs
1 parent c0eecd0 commit c4918cf

File tree

1 file changed

+9
-6
lines changed

1 file changed

+9
-6
lines changed

src/index.ts

Lines changed: 9 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,9 @@
11
/**
2-
* @module:@admin-bro/nestjs
2+
* @module @admin-bro/nestjs
3+
* @subcategory Plugins
4+
* @section modules
35
*
4-
* @description
6+
* @classdesc
57
* This is an official plugin which allows you to render AdminBro in [NestJS
68
* framework](https://nestjs.com/)
79
*
@@ -36,7 +38,7 @@
3638
* import { Module } from '@nestjs/common';
3739
* import { AdminModule } from '@admin-bro/nestjs';
3840
*
39-
* @Module({
41+
* \@Module({
4042
* imports: [
4143
* AdminModule.createAdmin({
4244
* rootPath: '/admin',
@@ -67,7 +69,7 @@
6769
*
6870
* AdminBro.registerAdapter({ Database, Resource })
6971
*
70-
* @Module({
72+
* \@Module({
7173
* imports: [
7274
* // you will have to change connection data of course :)
7375
* TypeOrmModule.forRoot({
@@ -124,8 +126,9 @@
124126
*
125127
* For example:
126128
* - we have MongooseSchemasModule which defines Admin model and exports it:
129+
*
127130
* ```
128-
* @Module({
131+
* \@Module({
129132
* imports: [
130133
* MongooseModule.forFeature([{ name: 'Admin', schema: AdminSchema }]),
131134
* ],
@@ -135,7 +138,7 @@
135138
* ```
136139
* - we want to use Admin model in admin-bro panel, to be displayed as the resource
137140
* ```
138-
* @Module({
141+
* \@Module({
139142
* imports: [
140143
* MongooseModule.forRoot('mongodb://localhost:27017/test'),
141144
* AdminModule.createAdminAsync({

0 commit comments

Comments
 (0)