Skip to content

Commit db18e65

Browse files
committed
📝 Updated documentation
1 parent 55ac829 commit db18e65

207 files changed

Lines changed: 207 additions & 205 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

docs/data/documentation/cidercsskit.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.

docs/data/documentation/cidercsskit/cssangleunit.json

Lines changed: 1 addition & 1 deletion
Large diffs are not rendered by default.
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"metadata":{"extendedModule":"Swift","role":"symbol","fragments":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"!="},{"text":" ","kind":"text"},{"kind":"text","text":"("},{"text":"Self","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"Self","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"preciseIdentifier":"s:Sb","text":"Bool","kind":"typeIdentifier"}],"externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:11CiderCSSKit12CSSAngleUnitO","modules":[{"name":"CiderCSSKit","relatedModules":["Swift"]}],"title":"!=(_:_:)","roleHeading":"Operator","symbolKind":"op"},"hierarchy":{"paths":[["doc:\/\/CiderCSSKit\/documentation\/CiderCSSKit","doc:\/\/CiderCSSKit\/documentation\/CiderCSSKit\/CSSAngleUnit","doc:\/\/CiderCSSKit\/documentation\/CiderCSSKit\/CSSAngleUnit\/Equatable-Implementations"]]},"variants":[{"paths":["\/documentation\/cidercsskit\/cssangleunit\/!=(_:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"schemaVersion":{"minor":3,"major":0,"patch":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"languages":["swift"],"platforms":["macOS"],"tokens":[{"kind":"keyword","text":"static"},{"kind":"text","text":" "},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"lhs","kind":"internalParam"},{"kind":"text","text":": "},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"internalParam","text":"rhs"},{"kind":"text","text":": "},{"text":"Self","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}]}]}],"abstract":[{"type":"text","text":"Inherited from "},{"code":"Equatable.!=(_:_:)","type":"codeVoice"},{"type":"text","text":"."}],"kind":"symbol","identifier":{"interfaceLanguage":"swift","url":"doc:\/\/CiderCSSKit\/documentation\/CiderCSSKit\/CSSAngleUnit\/!=(_:_:)"},"sections":[],"references":{"doc://CiderCSSKit/documentation/CiderCSSKit":{"type":"topic","url":"\/documentation\/cidercsskit","abstract":[{"text":"A fast and lightweight CSS parser, written as a pure Swift package","type":"text"}],"identifier":"doc:\/\/CiderCSSKit\/documentation\/CiderCSSKit","title":"CiderCSSKit","role":"collection","kind":"symbol"},"doc://CiderCSSKit/documentation/CiderCSSKit/CSSAngleUnit/Equatable-Implementations":{"url":"\/documentation\/cidercsskit\/cssangleunit\/equatable-implementations","title":"Equatable Implementations","role":"collectionGroup","identifier":"doc:\/\/CiderCSSKit\/documentation\/CiderCSSKit\/CSSAngleUnit\/Equatable-Implementations","type":"topic","kind":"article","abstract":[]},"doc://CiderCSSKit/documentation/CiderCSSKit/CSSAngleUnit/!=(_:_:)":{"identifier":"doc:\/\/CiderCSSKit\/documentation\/CiderCSSKit\/CSSAngleUnit\/!=(_:_:)","title":"!=(_:_:)","role":"symbol","kind":"symbol","abstract":[],"url":"\/documentation\/cidercsskit\/cssangleunit\/!=(_:_:)","type":"topic","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"!="},{"kind":"text","text":" "},{"kind":"text","text":"("},{"kind":"typeIdentifier","text":"Self"},{"kind":"text","text":", "},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}]},"doc://CiderCSSKit/documentation/CiderCSSKit/CSSAngleUnit":{"type":"topic","role":"symbol","navigatorTitle":[{"text":"CSSAngleUnit","kind":"identifier"}],"identifier":"doc:\/\/CiderCSSKit\/documentation\/CiderCSSKit\/CSSAngleUnit","url":"\/documentation\/cidercsskit\/cssangleunit","title":"CSSAngleUnit","abstract":[],"fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"CSSAngleUnit","kind":"identifier"}],"kind":"symbol"}}}
1+
{"abstract":[{"type":"text","text":"Inherited from "},{"code":"Equatable.!=(_:_:)","type":"codeVoice"},{"type":"text","text":"."}],"metadata":{"symbolKind":"op","roleHeading":"Operator","extendedModule":"Swift","role":"symbol","modules":[{"relatedModules":["Swift"],"name":"CiderCSSKit"}],"fragments":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"kind":"text","text":" "},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"text":"Bool","preciseIdentifier":"s:Sb","kind":"typeIdentifier"}],"externalID":"s:SQsE2neoiySbx_xtFZ::SYNTHESIZED::s:11CiderCSSKit12CSSAngleUnitO","title":"!=(_:_:)"},"primaryContentSections":[{"declarations":[{"platforms":["macOS"],"tokens":[{"kind":"keyword","text":"static"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"lhs","kind":"internalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"text":", ","kind":"text"},{"text":"rhs","kind":"internalParam"},{"text":": ","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":") -> ","kind":"text"},{"preciseIdentifier":"s:Sb","kind":"typeIdentifier","text":"Bool"}],"languages":["swift"]}],"kind":"declarations"}],"schemaVersion":{"major":0,"patch":0,"minor":3},"hierarchy":{"paths":[["doc:\/\/CiderCSSKit\/documentation\/CiderCSSKit","doc:\/\/CiderCSSKit\/documentation\/CiderCSSKit\/CSSAngleUnit","doc:\/\/CiderCSSKit\/documentation\/CiderCSSKit\/CSSAngleUnit\/Equatable-Implementations"]]},"identifier":{"url":"doc:\/\/CiderCSSKit\/documentation\/CiderCSSKit\/CSSAngleUnit\/!=(_:_:)","interfaceLanguage":"swift"},"kind":"symbol","variants":[{"paths":["\/documentation\/cidercsskit\/cssangleunit\/!=(_:_:)"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"references":{"doc://CiderCSSKit/documentation/CiderCSSKit/CSSAngleUnit":{"identifier":"doc:\/\/CiderCSSKit\/documentation\/CiderCSSKit\/CSSAngleUnit","url":"\/documentation\/cidercsskit\/cssangleunit","title":"CSSAngleUnit","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"CSSAngleUnit","kind":"identifier"}],"kind":"symbol","abstract":[{"type":"text","text":"Units used for angle values"}],"navigatorTitle":[{"kind":"identifier","text":"CSSAngleUnit"}],"type":"topic","role":"symbol"},"doc://CiderCSSKit/documentation/CiderCSSKit/CSSAngleUnit/Equatable-Implementations":{"type":"topic","title":"Equatable Implementations","kind":"article","identifier":"doc:\/\/CiderCSSKit\/documentation\/CiderCSSKit\/CSSAngleUnit\/Equatable-Implementations","url":"\/documentation\/cidercsskit\/cssangleunit\/equatable-implementations","role":"collectionGroup","abstract":[]},"doc://CiderCSSKit/documentation/CiderCSSKit":{"title":"CiderCSSKit","type":"topic","abstract":[{"type":"text","text":"A fast and lightweight CSS parser, written as a pure Swift package"}],"kind":"symbol","identifier":"doc:\/\/CiderCSSKit\/documentation\/CiderCSSKit","role":"collection","url":"\/documentation\/cidercsskit"},"doc://CiderCSSKit/documentation/CiderCSSKit/CSSAngleUnit/!=(_:_:)":{"type":"topic","fragments":[{"text":"static","kind":"keyword"},{"text":" ","kind":"text"},{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"!=","kind":"identifier"},{"text":" ","kind":"text"},{"text":"(","kind":"text"},{"text":"Self","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"Self"},{"text":") -> ","kind":"text"},{"text":"Bool","kind":"typeIdentifier","preciseIdentifier":"s:Sb"}],"title":"!=(_:_:)","identifier":"doc:\/\/CiderCSSKit\/documentation\/CiderCSSKit\/CSSAngleUnit\/!=(_:_:)","kind":"symbol","url":"\/documentation\/cidercsskit\/cssangleunit\/!=(_:_:)","role":"symbol","abstract":[]}}}
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"abstract":[{"type":"text","text":"Converts an angle value to another unit"}],"schemaVersion":{"major":0,"minor":3,"patch":0},"kind":"symbol","hierarchy":{"paths":[["doc:\/\/CiderCSSKit\/documentation\/CiderCSSKit","doc:\/\/CiderCSSKit\/documentation\/CiderCSSKit\/CSSAngleUnit"]]},"metadata":{"symbolKind":"method","modules":[{"name":"CiderCSSKit"}],"externalID":"s:11CiderCSSKit12CSSAngleUnitO7convert6amount2toS2f_ACtF","title":"convert(amount:to:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"convert","kind":"identifier"},{"kind":"text","text":"("},{"text":"amount","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sf","text":"Float"},{"text":", ","kind":"text"},{"kind":"externalParam","text":"to"},{"kind":"text","text":": "},{"text":"CSSAngleUnit","kind":"typeIdentifier","preciseIdentifier":"s:11CiderCSSKit12CSSAngleUnitO"},{"text":") -> ","kind":"text"},{"text":"Float","kind":"typeIdentifier","preciseIdentifier":"s:Sf"}],"roleHeading":"Instance Method","role":"symbol"},"primaryContentSections":[{"declarations":[{"tokens":[{"text":"func","kind":"keyword"},{"kind":"text","text":" "},{"text":"convert","kind":"identifier"},{"kind":"text","text":"("},{"text":"amount","kind":"externalParam"},{"text":": ","kind":"text"},{"text":"Float","kind":"typeIdentifier","preciseIdentifier":"s:Sf"},{"text":" = 1, ","kind":"text"},{"text":"to","kind":"externalParam"},{"kind":"text","text":" "},{"kind":"internalParam","text":"destinationUnit"},{"text":": ","kind":"text"},{"text":"CSSAngleUnit","preciseIdentifier":"s:11CiderCSSKit12CSSAngleUnitO","kind":"typeIdentifier","identifier":"doc:\/\/CiderCSSKit\/documentation\/CiderCSSKit\/CSSAngleUnit"},{"text":") -> ","kind":"text"},{"text":"Float","preciseIdentifier":"s:Sf","kind":"typeIdentifier"}],"languages":["swift"],"platforms":["macOS"]}],"kind":"declarations"},{"kind":"parameters","parameters":[{"content":[{"type":"paragraph","inlineContent":[{"text":"how many of the current unit to use for the conversion. Defaults to ","type":"text"},{"code":"1","type":"codeVoice"}]}],"name":"amount"},{"name":"destinationUnit","content":[{"type":"paragraph","inlineContent":[{"text":"Unit to which the conversion must be done","type":"text"}]}]}]},{"kind":"content","content":[{"level":2,"text":"Return Value","anchor":"return-value","type":"heading"},{"inlineContent":[{"type":"text","text":"The amount of the current unit converted to the destination unit as a "},{"code":"Float","type":"codeVoice"}],"type":"paragraph"}]},{"kind":"content","content":[{"level":2,"anchor":"discussion","text":"Discussion","type":"heading"},{"type":"paragraph","inlineContent":[{"text":"Angle values are always specified with a unit in CSS. This method helps converting one unit to another with an optional amount.","type":"text"}]},{"type":"codeListing","code":["let tenDegreesInRadians = CSSAngleUnit.deg.convert(amount: 10, to: .rad)","print(tenDegreesInRadians) \/\/ Prints 0.174532925199433"],"syntax":null}]}],"sections":[],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/cidercsskit\/cssangleunit\/convert(amount:to:)"]}],"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/CiderCSSKit\/documentation\/CiderCSSKit\/CSSAngleUnit\/convert(amount:to:)"},"references":{"doc://CiderCSSKit/documentation/CiderCSSKit/CSSAngleUnit/convert(amount:to:)":{"abstract":[{"text":"Converts an angle value to another unit","type":"text"}],"title":"convert(amount:to:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"convert"},{"text":"(","kind":"text"},{"text":"amount","kind":"externalParam"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sf","text":"Float"},{"kind":"text","text":", "},{"kind":"externalParam","text":"to"},{"text":": ","kind":"text"},{"text":"CSSAngleUnit","preciseIdentifier":"s:11CiderCSSKit12CSSAngleUnitO","kind":"typeIdentifier"},{"kind":"text","text":") -> "},{"text":"Float","kind":"typeIdentifier","preciseIdentifier":"s:Sf"}],"url":"\/documentation\/cidercsskit\/cssangleunit\/convert(amount:to:)","kind":"symbol","identifier":"doc:\/\/CiderCSSKit\/documentation\/CiderCSSKit\/CSSAngleUnit\/convert(amount:to:)","type":"topic","role":"symbol"},"doc://CiderCSSKit/documentation/CiderCSSKit/CSSAngleUnit":{"identifier":"doc:\/\/CiderCSSKit\/documentation\/CiderCSSKit\/CSSAngleUnit","url":"\/documentation\/cidercsskit\/cssangleunit","title":"CSSAngleUnit","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"CSSAngleUnit","kind":"identifier"}],"kind":"symbol","abstract":[{"type":"text","text":"Units used for angle values"}],"navigatorTitle":[{"kind":"identifier","text":"CSSAngleUnit"}],"type":"topic","role":"symbol"},"doc://CiderCSSKit/documentation/CiderCSSKit":{"title":"CiderCSSKit","type":"topic","abstract":[{"type":"text","text":"A fast and lightweight CSS parser, written as a pure Swift package"}],"kind":"symbol","identifier":"doc:\/\/CiderCSSKit\/documentation\/CiderCSSKit","role":"collection","url":"\/documentation\/cidercsskit"}}}
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1 @@
1-
{"hierarchy":{"paths":[["doc:\/\/CiderCSSKit\/documentation\/CiderCSSKit","doc:\/\/CiderCSSKit\/documentation\/CiderCSSKit\/CSSAngleUnit"]]},"identifier":{"url":"doc:\/\/CiderCSSKit\/documentation\/CiderCSSKit\/CSSAngleUnit\/deg","interfaceLanguage":"swift"},"schemaVersion":{"patch":0,"major":0,"minor":3},"sections":[],"kind":"symbol","primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"case"},{"kind":"text","text":" "},{"text":"deg","kind":"identifier"}],"languages":["swift"],"platforms":["macOS"]}],"kind":"declarations"}],"metadata":{"externalID":"s:11CiderCSSKit12CSSAngleUnitO3degyA2CmF","symbolKind":"case","role":"symbol","title":"CSSAngleUnit.deg","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"deg"}],"modules":[{"name":"CiderCSSKit"}],"roleHeading":"Case"},"variants":[{"paths":["\/documentation\/cidercsskit\/cssangleunit\/deg"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://CiderCSSKit/documentation/CiderCSSKit/CSSAngleUnit/deg":{"type":"topic","identifier":"doc:\/\/CiderCSSKit\/documentation\/CiderCSSKit\/CSSAngleUnit\/deg","kind":"symbol","abstract":[],"title":"CSSAngleUnit.deg","role":"symbol","fragments":[{"text":"case","kind":"keyword"},{"kind":"text","text":" "},{"text":"deg","kind":"identifier"}],"url":"\/documentation\/cidercsskit\/cssangleunit\/deg"},"doc://CiderCSSKit/documentation/CiderCSSKit":{"type":"topic","url":"\/documentation\/cidercsskit","abstract":[{"text":"A fast and lightweight CSS parser, written as a pure Swift package","type":"text"}],"identifier":"doc:\/\/CiderCSSKit\/documentation\/CiderCSSKit","title":"CiderCSSKit","role":"collection","kind":"symbol"},"doc://CiderCSSKit/documentation/CiderCSSKit/CSSAngleUnit":{"type":"topic","role":"symbol","navigatorTitle":[{"text":"CSSAngleUnit","kind":"identifier"}],"identifier":"doc:\/\/CiderCSSKit\/documentation\/CiderCSSKit\/CSSAngleUnit","url":"\/documentation\/cidercsskit\/cssangleunit","title":"CSSAngleUnit","abstract":[],"fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"CSSAngleUnit","kind":"identifier"}],"kind":"symbol"}}}
1+
{"schemaVersion":{"major":0,"minor":3,"patch":0},"hierarchy":{"paths":[["doc:\/\/CiderCSSKit\/documentation\/CiderCSSKit","doc:\/\/CiderCSSKit\/documentation\/CiderCSSKit\/CSSAngleUnit"]]},"identifier":{"interfaceLanguage":"swift","url":"doc:\/\/CiderCSSKit\/documentation\/CiderCSSKit\/CSSAngleUnit\/deg"},"kind":"symbol","sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"languages":["swift"],"tokens":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"deg"}]}]}],"abstract":[{"text":"Represents an angle in degrees. One full circle is ","type":"text"},{"type":"codeVoice","code":"360deg"},{"type":"text","text":". Examples: "},{"code":"0deg","type":"codeVoice"},{"text":", ","type":"text"},{"code":"90deg","type":"codeVoice"},{"text":", ","type":"text"},{"code":"14.23deg","type":"codeVoice"},{"type":"text","text":"."}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/cidercsskit\/cssangleunit\/deg"]}],"metadata":{"modules":[{"name":"CiderCSSKit"}],"roleHeading":"Case","title":"CSSAngleUnit.deg","fragments":[{"kind":"keyword","text":"case"},{"text":" ","kind":"text"},{"text":"deg","kind":"identifier"}],"symbolKind":"case","role":"symbol","externalID":"s:11CiderCSSKit12CSSAngleUnitO3degyA2CmF"},"references":{"doc://CiderCSSKit/documentation/CiderCSSKit":{"title":"CiderCSSKit","type":"topic","abstract":[{"type":"text","text":"A fast and lightweight CSS parser, written as a pure Swift package"}],"kind":"symbol","identifier":"doc:\/\/CiderCSSKit\/documentation\/CiderCSSKit","role":"collection","url":"\/documentation\/cidercsskit"},"doc://CiderCSSKit/documentation/CiderCSSKit/CSSAngleUnit/deg":{"identifier":"doc:\/\/CiderCSSKit\/documentation\/CiderCSSKit\/CSSAngleUnit\/deg","url":"\/documentation\/cidercsskit\/cssangleunit\/deg","kind":"symbol","type":"topic","role":"symbol","title":"CSSAngleUnit.deg","fragments":[{"text":"case","kind":"keyword"},{"text":" ","kind":"text"},{"text":"deg","kind":"identifier"}],"abstract":[{"text":"Represents an angle in degrees. One full circle is ","type":"text"},{"type":"codeVoice","code":"360deg"},{"text":". Examples: ","type":"text"},{"code":"0deg","type":"codeVoice"},{"type":"text","text":", "},{"code":"90deg","type":"codeVoice"},{"text":", ","type":"text"},{"type":"codeVoice","code":"14.23deg"},{"type":"text","text":"."}]},"doc://CiderCSSKit/documentation/CiderCSSKit/CSSAngleUnit":{"identifier":"doc:\/\/CiderCSSKit\/documentation\/CiderCSSKit\/CSSAngleUnit","url":"\/documentation\/cidercsskit\/cssangleunit","title":"CSSAngleUnit","fragments":[{"text":"enum","kind":"keyword"},{"kind":"text","text":" "},{"text":"CSSAngleUnit","kind":"identifier"}],"kind":"symbol","abstract":[{"type":"text","text":"Units used for angle values"}],"navigatorTitle":[{"kind":"identifier","text":"CSSAngleUnit"}],"type":"topic","role":"symbol"}}}

0 commit comments

Comments
 (0)