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
Swift tool to generate Module Interfaces for Swift projects.
5
9
@@ -26,6 +30,83 @@ help Display general or command-specific help
26
30
version Display the current version of ModuleInterface
27
31
```
28
32
29
-
Typing `moduleinterfacep` help <command> we get a list of all options for that command
33
+
Typing `moduleinterfacep` help <command> we get a list of all options for that command:
30
34
35
+
```
36
+
Generates the Swift Module Interface.
37
+
38
+
[--spm-module (string)]
39
+
Generate documentation for Swift Package Manager module.
40
+
41
+
[--module-name (string)]
42
+
Generate documentation for a Swift module.
43
+
44
+
[--input-folder (string)]
45
+
Path to the input directory (defaults to /Users/minuscorp/Documents/GitHub/ModuleInterface).
46
+
47
+
[--output-folder (string)]
48
+
Output directory (defaults to Documentation).
49
+
50
+
[--min-acl (string)]
51
+
The minimum access level to generate documentation. Defaults to public.
52
+
53
+
--clean|-c
54
+
Delete output folder before generating documentation.
55
+
56
+
[[]]
57
+
List of arguments to pass to xcodebuild.
58
+
```
59
+
60
+
Usually, for most Xcode projects, no parameters are needed at all. xcodebuild should be able to find the default project and scheme.
61
+
62
+
If the command fails, try specifying the scheme (-scheme SchemeName) or the workspace. Any arguments passed to sourcedocs after -- will be passed to xcodebuild without modification.
63
+
64
+
`$ moduleinterface generate -- -scheme MyScheme`
65
+
66
+
For Swift Package Manager modules, you can the module name using the --spm-module parameter.
0 commit comments