Skip to content
This repository was archived by the owner on Nov 30, 2021. It is now read-only.

Commit 2554556

Browse files
author
Alistair Laing
committed
fix up some comments
1 parent d563e26 commit 2554556

1 file changed

Lines changed: 6 additions & 5 deletions

File tree

lib/extensions/extensions.js

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,23 +9,24 @@
99
* getPublicUrls:
1010
* Params: (type | string ) eg. 'scripts', 'stylesheets'
1111
* Description:
12-
* returns array of urls for a type (script, stylesheet, nunjucks etc). do we need to expose this?
12+
* returns array of urls for a type (script, stylesheet, nunjucks etc).
1313
* getFileSystemPaths:
1414
* Params: (type | string ) eg. 'scripts', 'stylesheets'
1515
* Description:
16-
* returns array paths to the file in the filesystem for a type (script, stylesheet, nunjucks etc) do we need to expose this?
16+
* returns array paths to the file in the filesystem for a type (script, stylesheet, nunjucks etc)
1717
* getPublicUrlAndFileSystemPaths:
1818
* Params: (type | string ) eg. 'scripts', 'stylesheets'
1919
* Description:
2020
* returns Array of objects, each object is an extension and each obj has the filesystem & public url for the given type
2121
* getAppConfig:
2222
* Params: (type | string ) eg. 'scripts', 'stylesheets'
2323
* Description:
24-
* to do
24+
* Returns an object containing two keys(scripts & stylesheets), each item contains an array of full paths to specific files.
25+
* This is used in the views to output links and scripts each file.
2526
* getAppViews:
26-
* Params: (type | string ) eg. 'scripts', 'stylesheets'
27+
* Params: (additionalViews | Array ) eg.extensions.getAppViews([path.join(__dirname, '/app/views/'),path.join(__dirname, '/lib/')])
2728
* Description:
28-
* To do
29+
* Returns an array of paths to nunjucks templates which is used to configure nunjucks in server.js
2930
* setExtensionsByType
3031
* Params: N/A
3132
* Description: only used for test purposes to reset mocked extensions items to ensure they are up-to-date when the tests run

0 commit comments

Comments
 (0)