Skip to content

Commit e2d2c63

Browse files
committed
Improve doc
1 parent 160e5f4 commit e2d2c63

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

Readme.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -331,16 +331,18 @@ Options to configure JavaScript file generator. These options are only available
331331
* `optional_definition_params` - make all route paramters in definition optional
332332
* See [related compatibility issue](#optional-definition-params)
333333
* Default: `false`
334-
* `banner` - specify the comment on top of the file.
334+
* `banner` - specify a JSDoc comment on top of the file.
335335
* It is not stripped by minifiers by default and helps to originate the content when debugging the build.
336336
* You may want to control how much information from backend is exposed to potential attacker at the cost of your own comfort.
337337
* See [JSDoc Guide](https://github.com/shri/JSDoc-Style-Guide/blob/master/README.md#files)
338338
* Supports a lazy generation with `Proc`.
339339
* Default: A string that generates the following:
340340

341341
```
342-
File generated by js-routes 2.3.1 on <TIMESTAMP>
343-
Based on Rails 7.2.0 routes of App
342+
/**
343+
* File generated by js-routes 2.3.1 on 2024-12-04 09:45:59 +0100
344+
* Based on Rails 7.2.0 routes of App
345+
*/
344346
```
345347

346348
<div id="formatter-options"></div>

0 commit comments

Comments
 (0)