File: README.md

package info (click to toggle)
swiftlang 6.1.3-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 2,791,532 kB
  • sloc: cpp: 9,901,743; ansic: 2,201,431; asm: 1,091,827; python: 308,252; objc: 82,166; f90: 80,126; lisp: 38,358; pascal: 25,559; sh: 20,429; ml: 5,058; perl: 4,745; makefile: 4,484; awk: 3,535; javascript: 3,018; xml: 918; fortran: 664; cs: 573; ruby: 396
file content (20 lines) | stat: -rw-r--r-- 732 bytes parent folder | download | duplicates (2) 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
 
# make-test-bundle

A CLI tool that generates a Swift framework for testing with docc.

## Usage

```
swift run make-test-bundle --output path/to/folder --sizeFactor 10
```

 - `--output` the path to the output folder, `make-test-bundle` creates a sub-directory at that location called `TestFramework` and places its output inside.
 - `--sizeFactor` how many of each node to create. For example setting this parameter to 10 will create 10 protocols, 10 structs, 10 top-level functions, etc. Use a value greater than 1.
 
To preview the generated bundle documentation bundle run:
 
```
docc preview path/to/folder/TestFramework/Docs.docc
```

<!-- Copyright (c) 2021 Apple Inc and the Swift Project authors. All Rights Reserved. -->