Skip to content

Commit 4f6dce7

Browse files
committed
docs: module doc and readme example
1 parent 48b7414 commit 4f6dce7

File tree

4 files changed

+15
-2
lines changed

4 files changed

+15
-2
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,10 @@
1212
[Danet](https://github.com/Savory/Danet).
1313

1414
## Quick Start
15-
15+
```bash
16+
deno install --global -A -n danet jsr:@danet/cli
17+
danet new <my-project>
18+
```
1619
[Overview & Tutorial](https://savory.github.io/Danet/openapi/introduction/)
1720

1821
## License

decorators.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
/**
2+
* @module
3+
* Provides decorators to define metadata to generate your openAPI/Swagger documentation.
4+
*/
5+
16
import { BODY_TYPE_KEY, MetadataHelper, QUERY_TYPE_KEY } from './deps.ts';
27
import { Constructor } from './mod.ts';
38
import { Swagger } from "./swagger.ts";

deno.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
{
22
"name": "@danet/swagger",
3-
"version": "2.1.4",
3+
"version": "2.1.5",
44
"exports": {
55
".":"./mod.ts",
66
"./decorators": "./decorators.ts"

mod.ts

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,8 @@
1+
/**
2+
* @module
3+
* SwaggerModule provides methods to generate and set up Swagger documentation for a Danet application.
4+
*/
5+
16
import {
27
DanetApplication,
38
MetadataHelper,

0 commit comments

Comments
 (0)