You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on May 1, 2020. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+10-2Lines changed: 10 additions & 2 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -90,7 +90,7 @@ Toggles `--no-prefix` that does not include the comment header.
90
90
91
91
###### `ffi` (String Array)
92
92
93
-
Sets one or more `--ffi=<string>` that specifies the location of files for code that is included with a `foreign import` in the PureScript source.
93
+
Sets one or more `--ffi=<string>` that specifies the files for code that is included with a `foreign import` in the PureScript source.
94
94
95
95
### `purescript.pscMake(options)`
96
96
@@ -130,7 +130,7 @@ Toggles `--no-prefix` that does not include the comment header.
130
130
131
131
###### `ffi` (String Array)
132
132
133
-
Sets one or more `--ffi=<string>` that specifies the location of files for code that is included with a `foreign import` in the PureScript source.
133
+
Sets one or more `--ffi=<string>` that specifies files for code that is included with a `foreign import` in the PureScript source.
134
134
135
135
### `purescript.pscDocs(options)`
136
136
@@ -140,6 +140,14 @@ Invokes the `pscDocs` command. The following options are supported.
140
140
141
141
Sets `--output=<markdown|etags|ctags>` that specifies the output format.
142
142
143
+
###### `docgen` (String | String Array | Object)
144
+
145
+
Sets `--docgen=...` that can be used to filter the modules documentation is generated for.
146
+
147
+
- If a string value is provided, the documentation for that single module will be generated.
148
+
- If a list of strings is provided, the documentation for all listed modules will be generated.
149
+
- If an object with module name/filename pairs (for example, `{ Module: "docs/Module.md" }`) is provided, files will be written for each of the modules. In this mode, the task requires no `dest` as no value is returned.
150
+
143
151
### `purescript.dotPsci()`
144
152
145
153
Generates a `.psci` file in the current directory. Each source file is added with the `:m` command.
0 commit comments