Skip to content

Commit 53060c6

Browse files
committed
Added Documentation catalog
1 parent 890a9de commit 53060c6

File tree

2 files changed

+13
-6
lines changed

2 files changed

+13
-6
lines changed
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
# ``CodeEditKit``
2+
3+
CodeEditKit is a dynamic library which is shared between CodeEdit and it's extensions. It allows them to communicate with and understand one another.
4+
5+
## Overview
6+
7+
This is still work in progress.

Sources/CodeEditKit/Targets/Target.swift

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -32,22 +32,22 @@ public struct Target: Identifiable {
3232
self.execName = execName
3333
}
3434

35-
/// ``id`` is a unique identifier of the target set by the extension
35+
/// `id` is a unique identifier of the target set by the extension
3636
public var id: String
3737

38-
/// ``displayName`` is a name to be displayed in the UI to represent target
38+
/// `displayName` is a name to be displayed in the UI to represent target
3939
public var displayName: String
4040

41-
/// ``executable`` is the executable to launch inside the pseudo terminal
41+
/// `executable` is the executable to launch inside the pseudo terminal
4242
public var executable: String
4343

44-
/// ``args`` is an array of strings that is passed as the arguments to the underlying process
44+
/// `args` is an array of strings that is passed as the arguments to the underlying process
4545
public var args: [String] = []
4646

47-
/// ``environment`` is an array of environment variables to pass to the child process.
47+
/// `environment` is an array of environment variables to pass to the child process.
4848
public var environment: [String]?
4949

50-
/// ``execName`` If provided, this is used as the Unix argv[0] parameter, otherwise,
50+
/// `execName` If provided, this is used as the Unix argv[0] parameter, otherwise,
5151
/// the executable is used as the args [0], this is used when the intent is to set a different
5252
/// process name than the file that backs it.
5353
public var execName: String?

0 commit comments

Comments
 (0)