Skip to content

Commit

Permalink
refactor: update source comments
Browse files Browse the repository at this point in the history
  • Loading branch information
bsorrentino committed Mar 13, 2023
1 parent 2510ac7 commit 8262e89
Show file tree
Hide file tree
Showing 7 changed files with 21 additions and 20 deletions.
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import Foundation

/// [Colors supported by PlantUML](https://github.com/qywx/PlantUML-colors/blob/master/plantuml-colors-table.puml)
/// Colors supported by PlantUML: (https://github.com/qywx/PlantUML-colors/blob/master/plantuml-colors-table.puml)
public enum Color: String, CaseIterable, Codable {
/// AliceBlue
case AliceBlue
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ public enum AccessLevel: String, Codable {
case `private`
}

// [Class Diagram](https://plantuml.com/class-diagram)
// Class Diagram: (https://plantuml.com/class-diagram)
/// Configuration options to influence the generation and visual representation of the class diagram
public struct Configuration: Codable {
/// memberwise initializer
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ public struct ElementOptions: Codable {
/// show Swift extensions (default: true)
public private(set) var showExtensions: Bool = true

/// [show access level](https://plantuml.com/class-diagram#3644720244dd6c6a) for members
/// show access level: (https://plantuml.com/class-diagram#3644720244dd6c6a) for members
public private(set) var showMemberAccessLevelAttribute: Bool = true

/// exclude elements for given names (wildcard support with `*`), e.g. use `*Test*`to hide classes/structs/... who contain `Test` in their name
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ public struct Stereotypes: Codable {
public var `protocol`: Stereotype?
}

/// you can define your own spot for a entity when you define the stereotype, adding a single character and a color. [For further info](https://plantuml.com/class-diagram#4b62dd14f1d33739)
/// you can define your own spot for a entity when you define the stereotype, adding a single character and a color. For further info: (https://plantuml.com/class-diagram#4b62dd14f1d33739)
public struct Stereotype: Codable {
/// displayed as << name >> in diagram
public var name: String?
Expand All @@ -54,7 +54,7 @@ public struct Stereotype: Codable {
public private(set) static var `protocol` = Stereotype(name: "protocol", spot: Spot(character: "P", color: .GoldenRod))
}

/// Usually, a spotted character (C, S, E, X or P) is used for classes, struct, enum, extension and protocols. But you can define your own spot for a entity when you define the stereotype, adding a single character and a color. [For further info](https://plantuml.com/class-diagram#4b62dd14f1d33739)
/// Usually, a spotted character (C, S, E, X or P) is used for classes, struct, enum, extension and protocols. But you can define your own spot for a entity when you define the stereotype, adding a single character and a color. For further info: (https://plantuml.com/class-diagram#4b62dd14f1d33739)
public struct Spot : Codable {
/// spotted character
public var character: Character
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ public struct PlantUMLScript : CustomStringConvertible {
}

/**
encodes diagram text description according to PlantUML. [PlantUML Text Encoding](https://plantuml.com/en/text-encoding) for more information.
encodes diagram text description according to PlantUML. PlantUML Text Encoding: (https://plantuml.com/en/text-encoding) for more information.

1. Encoded in UTF-8
2. Compressed using Deflate algorithm
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ internal extension PlantUMLText {
For PlantUML, the mapping array for values 0-63 is:
`0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz-_`

[PlantUML Text Encoding](https://plantuml.com/en/text-encoding) for more info
PlantUML Text Encoding: (https://plantuml.com/en/text-encoding) for more info

- Parameter compressedData: of a deflated string
- Returns: encoded string
Expand Down
27 changes: 14 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,21 +29,22 @@ This is a native PlantUML editor app for iPad. It allows using iPad to draw diag

Below all references that helped to develop such App

* [SwiftPlantUML](https://github.com/MarcoEidinger/SwiftPlantUML)
* [Regular Expression Capture Groups in Swift](https://www.advancedswift.com/regex-capture-groups/)
* [Split Picture in tiles and put in array](https://stackoverflow.com/a/73628496/521197)
* [How to detect device rotation](https://www.hackingwithswift.com/quick-start/swiftui/how-to-detect-device-rotation)
* [How can I add caching to AsyncImage](https://stackoverflow.com/a/70916651/521197)
* [Button border with corner radius in Swift UI](https://stackoverflow.com/a/62544642/521197)
* [Conditional modifier](https://designcode.io/swiftui-handbook-conditional-modifier)
* [Managing Focus in SwiftUI List Views](https://peterfriese.dev/posts/swiftui-list-focus/)
* [Document based app shows 2 back chevrons on iPad](https://stackoverflow.com/a/74245034/521197)
* [SwiftUI: Forcing an Update](https://stackoverflow.com/a/65095862/521197)
* [Class Diagram](https://plantuml.com/class-diagram)
* [Get the current first responder without using a private API](https://stackoverflow.com/a/1823360/521197)
* [Customizing Toggle with ToggleStyle](https://www.hackingwithswift.com/quick-start/swiftui/customizing-toggle-with-togglestyle)
* [Split Picture in tiles and put in array](https://stackoverflow.com/a/73628496/521197)
* [SwiftUI exporting or sharing files](https://stackoverflow.com/a/56828100/521197)
* [How to percent encode a URL String](https://useyourloaf.com/blog/how-to-percent-encode-a-url-string/)
* [Open-source themes for PlantUML diagrams](https://bschwarz.github.io/puml-themes/gallery.html)
* [Colors supported by PlantUML](https://github.com/qywx/PlantUML-colors/blob/master/plantuml-colors-table.puml)
* [PlantUML Text Encoding](https://plantuml.com/en/text-encoding)
* [show access level](https://plantuml.com/class-diagram#3644720244dd6c6a)
* [Managing Focus in SwiftUI List Views](https://peterfriese.dev/posts/swiftui-list-focus/)
* [Compressing and Decompressing Data with Buffer Compression](https://developer.apple.com/documentation/accelerate/compressing_and_decompressing_data_with_buffer_compression)
* [Get the current first responder without using a private API](https://stackoverflow.com/a/1823360/521197)
* [SwiftUI Let View disappear automatically](https://stackoverflow.com/a/60820491/521197)
* [How to convert a SwiftUI view to an image](https://www.hackingwithswift.com/quick-start/swiftui/how-to-convert-a-swiftui-view-to-an-image)
* [How can I add caching to AsyncImage](https://stackoverflow.com/a/70916651/521197)
* [How to Display Web Page Using WKWebView](https://www.appcoda.com/swiftui-wkwebview/)
* [SwiftUI exporting or sharing files](https://stackoverflow.com/a/56828100/521197)
* [Compressing and Decompressing Data with Buffer Compression](https://developer.apple.com/documentation/accelerate/compressing_and_decompressing_data_with_buffer_compression)
* [Customizing Toggle with ToggleStyle](https://www.hackingwithswift.com/quick-start/swiftui/customizing-toggle-with-togglestyle)
* [Get a binding from an environment value in SwiftUI](https://stackoverflow.com/q/69731360/521197)
* [Open-source themes for PlantUML diagrams](https://bschwarz.github.io/puml-themes/gallery.html)

0 comments on commit 8262e89

Please sign in to comment.