Skip to content

Commit 3e73e69

Browse files
committed
Fixing documentation
1 parent 2c03a2f commit 3e73e69

File tree

4 files changed

+35
-1
lines changed

4 files changed

+35
-1
lines changed

Sources/PublicModules/PADOutputGenerator/Documentation.docc/PADOutputGenerator.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,3 +23,37 @@ let markdownOutput: String = try outputGenerator.generate(
2323
warnings: warnings
2424
)
2525
```
26+
27+
---
28+
29+
Example output for ``PADOutputGenerator/MarkdownOutputGenerator``
30+
31+
## 👀 3 public changes detected
32+
_Comparing `old` to `new`_
33+
34+
---
35+
## SomeModule
36+
#### ❇️ Added
37+
```javascript
38+
public protocol NewProtocol {
39+
var property: String { get }
40+
}
41+
```
42+
#### 🔀 Changed
43+
```javascript
44+
// From
45+
open class SomeClass : SomeProtocol, OldProtocol
46+
47+
// To
48+
open class SomeClass : SomeProtocol, NewProtocol
49+
50+
/**
51+
Changes:
52+
- Added `NewProtocol` conformance
53+
- Removed `OldProtocol` conformance
54+
*/
55+
```
56+
#### 😶‍🌫️ Removed
57+
```javascript
58+
public protocol OldProtocol
59+
```

Sources/PublicModules/PADPackageFileAnalyzer/Documentation.docc/PADPackageFileAnalyzer.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# ``PADPackageFileAnalyzer``
22

3-
The ``PADPackageFileAnalyzer/PackageFileAnalyzer`` allows analyzing of 2 versions of a `Package.swift` file.
3+
The ``PADPackageFileAnalyzer/SwiftPackageFileAnalyzer`` allows analyzing of 2 versions of a `Package.swift` file.
44

55
It lists all changes to products, dependencies and targets + surfaces any warnings that the new version of the `Package.swift` file might have.
66
Under the hood it uses `swift package describe --type json` to get a description of the `Package.swift` file

0 commit comments

Comments
 (0)