Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add Swift DocC #12

Merged
merged 1 commit into from
Oct 18, 2023
Merged

Add Swift DocC #12

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/data/documentation/forcesimulation.json
View file
Open in desktop

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/data/documentation/forcesimulation/centerforce.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"primaryContentSections":[{"declarations":[{"languages":["swift"],"tokens":[{"text":"final","kind":"keyword"},{"kind":"text","text":" "},{"kind":"keyword","text":"class"},{"text":" ","kind":"text"},{"text":"CenterForce","kind":"identifier"},{"text":"<","kind":"text"},{"text":"NodeID","kind":"genericParameter"},{"kind":"text","text":", "},{"kind":"genericParameter","text":"V"},{"text":"> ","kind":"text"},{"text":"where","kind":"keyword"},{"kind":"text","text":" "},{"text":"NodeID","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"kind":"typeIdentifier","preciseIdentifier":"s:SH","text":"Hashable"},{"text":", ","kind":"text"},{"text":"V","kind":"typeIdentifier"},{"kind":"text","text":" : "},{"text":"VectorLike","preciseIdentifier":"s:6NDTree10VectorLikeP","kind":"typeIdentifier"},{"text":", ","kind":"text"},{"text":"V","kind":"typeIdentifier"},{"kind":"text","text":"."},{"kind":"typeIdentifier","text":"Scalar"},{"kind":"text","text":" == "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sd","text":"Double"}],"platforms":["macOS"]}],"kind":"declarations"}],"variants":[{"paths":["\/documentation\/forcesimulation\/centerforce"],"traits":[{"interfaceLanguage":"swift"}]}],"kind":"symbol","abstract":[{"text":"A force that represents links between nodes.","type":"text"}],"identifier":{"url":"doc:\/\/ForceSimulation\/documentation\/ForceSimulation\/CenterForce","interfaceLanguage":"swift"},"metadata":{"modules":[{"name":"ForceSimulation"}],"role":"symbol","externalID":"s:15ForceSimulation06CenterA0C","title":"CenterForce","roleHeading":"Class","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"CenterForce","kind":"identifier"}],"symbolKind":"class","navigatorTitle":[{"text":"CenterForce","kind":"identifier"}]},"schemaVersion":{"minor":3,"major":0,"patch":0},"sections":[],"hierarchy":{"paths":[["doc:\/\/ForceSimulation\/documentation\/ForceSimulation"]]},"topicSections":[{"title":"Instance Properties","identifiers":["doc:\/\/ForceSimulation\/documentation\/ForceSimulation\/CenterForce\/center","doc:\/\/ForceSimulation\/documentation\/ForceSimulation\/CenterForce\/strength"]},{"title":"Instance Methods","identifiers":["doc:\/\/ForceSimulation\/documentation\/ForceSimulation\/CenterForce\/apply(alpha:)"]}],"relationshipsSections":[{"kind":"relationships","identifiers":["doc:\/\/ForceSimulation\/documentation\/ForceSimulation\/ForceLike"],"type":"conformsTo","title":"Conforms To"}],"references":{"doc://ForceSimulation/documentation/ForceSimulation":{"identifier":"doc:\/\/ForceSimulation\/documentation\/ForceSimulation","role":"collection","abstract":[],"title":"ForceSimulation","type":"topic","kind":"symbol","url":"\/documentation\/forcesimulation"},"doc://ForceSimulation/documentation/ForceSimulation/CenterForce/center":{"url":"\/documentation\/forcesimulation\/centerforce\/center","fragments":[{"kind":"keyword","text":"var"},{"text":" ","kind":"text"},{"text":"center","kind":"identifier"},{"text":": ","kind":"text"},{"text":"V","kind":"typeIdentifier"}],"abstract":[],"identifier":"doc:\/\/ForceSimulation\/documentation\/ForceSimulation\/CenterForce\/center","kind":"symbol","title":"center","role":"symbol","type":"topic"},"doc://ForceSimulation/documentation/ForceSimulation/CenterForce":{"identifier":"doc:\/\/ForceSimulation\/documentation\/ForceSimulation\/CenterForce","abstract":[{"type":"text","text":"A force that represents links between nodes."}],"fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"CenterForce","kind":"identifier"}],"url":"\/documentation\/forcesimulation\/centerforce","type":"topic","kind":"symbol","title":"CenterForce","role":"symbol","navigatorTitle":[{"text":"CenterForce","kind":"identifier"}]},"doc://ForceSimulation/documentation/ForceSimulation/CenterForce/apply(alpha:)":{"url":"\/documentation\/forcesimulation\/centerforce\/apply(alpha:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"apply","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"alpha"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sd","text":"Double"},{"kind":"text","text":")"}],"abstract":[],"identifier":"doc:\/\/ForceSimulation\/documentation\/ForceSimulation\/CenterForce\/apply(alpha:)","kind":"symbol","title":"apply(alpha:)","role":"symbol","type":"topic"},"doc://ForceSimulation/documentation/ForceSimulation/ForceLike":{"kind":"symbol","role":"symbol","abstract":[{"text":"A protocol that represents a force.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"A force takes a simulation state and modifies its node positions and velocities."}],"type":"topic","title":"ForceLike","fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ForceLike","kind":"identifier"}],"url":"\/documentation\/forcesimulation\/forcelike","navigatorTitle":[{"text":"ForceLike","kind":"identifier"}],"identifier":"doc:\/\/ForceSimulation\/documentation\/ForceSimulation\/ForceLike"},"doc://ForceSimulation/documentation/ForceSimulation/CenterForce/strength":{"url":"\/documentation\/forcesimulation\/centerforce\/strength","fragments":[{"kind":"keyword","text":"var"},{"kind":"text","text":" "},{"kind":"identifier","text":"strength"},{"kind":"text","text":": "},{"text":"Double","kind":"typeIdentifier","preciseIdentifier":"s:Sd"}],"abstract":[],"identifier":"doc:\/\/ForceSimulation\/documentation\/ForceSimulation\/CenterForce\/strength","kind":"symbol","title":"strength","role":"symbol","type":"topic"}}}
{"metadata":{"role":"symbol","symbolKind":"class","fragments":[{"kind":"keyword","text":"class"},{"kind":"text","text":" "},{"text":"CenterForce","kind":"identifier"}],"title":"CenterForce","modules":[{"name":"ForceSimulation"}],"navigatorTitle":[{"kind":"identifier","text":"CenterForce"}],"externalID":"s:15ForceSimulation06CenterA0C","roleHeading":"Class"},"kind":"symbol","identifier":{"url":"doc:\/\/ForceSimulation\/documentation\/ForceSimulation\/CenterForce","interfaceLanguage":"swift"},"schemaVersion":{"minor":3,"patch":0,"major":0},"sections":[],"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"tokens":[{"text":"final","kind":"keyword"},{"kind":"text","text":" "},{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"text":"CenterForce","kind":"identifier"},{"text":"<","kind":"text"},{"text":"NodeID","kind":"genericParameter"},{"text":", ","kind":"text"},{"text":"V","kind":"genericParameter"},{"text":"> ","kind":"text"},{"text":"where","kind":"keyword"},{"text":" ","kind":"text"},{"text":"NodeID","kind":"typeIdentifier"},{"text":" : ","kind":"text"},{"text":"Hashable","kind":"typeIdentifier","preciseIdentifier":"s:SH"},{"text":", ","kind":"text"},{"kind":"typeIdentifier","text":"V"},{"text":" : ","kind":"text"},{"text":"VectorLike","preciseIdentifier":"s:6NDTree10VectorLikeP","kind":"typeIdentifier"},{"kind":"text","text":", "},{"text":"V","kind":"typeIdentifier"},{"text":".","kind":"text"},{"text":"Scalar","kind":"typeIdentifier"},{"kind":"text","text":" == "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sd","text":"Double"}],"languages":["swift"]}]}],"relationshipsSections":[{"identifiers":["doc:\/\/ForceSimulation\/documentation\/ForceSimulation\/ForceLike"],"title":"Conforms To","kind":"relationships","type":"conformsTo"}],"hierarchy":{"paths":[["doc:\/\/ForceSimulation\/documentation\/ForceSimulation"]]},"abstract":[{"text":"A force that represents links between nodes.","type":"text"}],"topicSections":[{"title":"Instance Properties","identifiers":["doc:\/\/ForceSimulation\/documentation\/ForceSimulation\/CenterForce\/center","doc:\/\/ForceSimulation\/documentation\/ForceSimulation\/CenterForce\/strength"]},{"title":"Instance Methods","identifiers":["doc:\/\/ForceSimulation\/documentation\/ForceSimulation\/CenterForce\/apply(alpha:)"]}],"variants":[{"paths":["\/documentation\/forcesimulation\/centerforce"],"traits":[{"interfaceLanguage":"swift"}]}],"references":{"doc://ForceSimulation/documentation/ForceSimulation/ForceLike":{"fragments":[{"text":"protocol","kind":"keyword"},{"text":" ","kind":"text"},{"text":"ForceLike","kind":"identifier"}],"navigatorTitle":[{"text":"ForceLike","kind":"identifier"}],"identifier":"doc:\/\/ForceSimulation\/documentation\/ForceSimulation\/ForceLike","kind":"symbol","type":"topic","url":"\/documentation\/forcesimulation\/forcelike","abstract":[{"text":"A protocol that represents a force.","type":"text"},{"text":" ","type":"text"},{"type":"text","text":"A force takes a simulation state and modifies its node positions and velocities."}],"title":"ForceLike","role":"symbol"},"doc://ForceSimulation/documentation/ForceSimulation/CenterForce/apply(alpha:)":{"url":"\/documentation\/forcesimulation\/centerforce\/apply(alpha:)","abstract":[],"type":"topic","identifier":"doc:\/\/ForceSimulation\/documentation\/ForceSimulation\/CenterForce\/apply(alpha:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"apply","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"alpha"},{"text":": ","kind":"text"},{"text":"Double","kind":"typeIdentifier","preciseIdentifier":"s:Sd"},{"text":")","kind":"text"}],"kind":"symbol","title":"apply(alpha:)","role":"symbol"},"doc://ForceSimulation/documentation/ForceSimulation/CenterForce":{"fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CenterForce"}],"identifier":"doc:\/\/ForceSimulation\/documentation\/ForceSimulation\/CenterForce","url":"\/documentation\/forcesimulation\/centerforce","kind":"symbol","abstract":[{"type":"text","text":"A force that represents links between nodes."}],"title":"CenterForce","type":"topic","role":"symbol","navigatorTitle":[{"text":"CenterForce","kind":"identifier"}]},"doc://ForceSimulation/documentation/ForceSimulation":{"url":"\/documentation\/forcesimulation","abstract":[],"title":"ForceSimulation","kind":"symbol","identifier":"doc:\/\/ForceSimulation\/documentation\/ForceSimulation","role":"collection","type":"topic"},"doc://ForceSimulation/documentation/ForceSimulation/CenterForce/strength":{"fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"strength"},{"text":": ","kind":"text"},{"text":"Double","kind":"typeIdentifier","preciseIdentifier":"s:Sd"}],"identifier":"doc:\/\/ForceSimulation\/documentation\/ForceSimulation\/CenterForce\/strength","title":"strength","kind":"symbol","abstract":[],"url":"\/documentation\/forcesimulation\/centerforce\/strength","type":"topic","role":"symbol"},"doc://ForceSimulation/documentation/ForceSimulation/CenterForce/center":{"url":"\/documentation\/forcesimulation\/centerforce\/center","abstract":[],"type":"topic","identifier":"doc:\/\/ForceSimulation\/documentation\/ForceSimulation\/CenterForce\/center","fragments":[{"text":"var","kind":"keyword"},{"text":" ","kind":"text"},{"text":"center","kind":"identifier"},{"kind":"text","text":": "},{"kind":"typeIdentifier","text":"V"}],"kind":"symbol","title":"center","role":"symbol"}}}
2 changes: 1 addition & 1 deletion docs/data/documentation/forcesimulation/centerforce/apply(alpha:).json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1 +1 @@
{"schemaVersion":{"major":0,"patch":0,"minor":3},"variants":[{"paths":["\/documentation\/forcesimulation\/centerforce\/apply(alpha:)"],"traits":[{"interfaceLanguage":"swift"}]}],"sections":[],"kind":"symbol","metadata":{"modules":[{"name":"ForceSimulation"}],"symbolKind":"method","role":"symbol","externalID":"s:15ForceSimulation06CenterA0C5apply5alphaySd_tF","roleHeading":"Instance Method","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"apply","kind":"identifier"},{"text":"(","kind":"text"},{"text":"alpha","kind":"externalParam"},{"kind":"text","text":": "},{"text":"Double","kind":"typeIdentifier","preciseIdentifier":"s:Sd"},{"kind":"text","text":")"}],"title":"apply(alpha:)"},"abstract":[{"text":"Inherited from ","type":"text"},{"type":"codeVoice","code":"ForceLike.apply(alpha:)"},{"type":"text","text":"."}],"primaryContentSections":[{"declarations":[{"tokens":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"kind":"identifier","text":"apply"},{"text":"(","kind":"text"},{"text":"alpha","kind":"externalParam"},{"text":": ","kind":"text"},{"kind":"typeIdentifier","text":"Double","preciseIdentifier":"s:Sd"},{"text":")","kind":"text"}],"languages":["swift"],"platforms":["macOS"]}],"kind":"declarations"}],"hierarchy":{"paths":[["doc:\/\/ForceSimulation\/documentation\/ForceSimulation","doc:\/\/ForceSimulation\/documentation\/ForceSimulation\/CenterForce"]]},"identifier":{"url":"doc:\/\/ForceSimulation\/documentation\/ForceSimulation\/CenterForce\/apply(alpha:)","interfaceLanguage":"swift"},"references":{"doc://ForceSimulation/documentation/ForceSimulation/CenterForce/apply(alpha:)":{"url":"\/documentation\/forcesimulation\/centerforce\/apply(alpha:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"apply","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"alpha"},{"kind":"text","text":": "},{"kind":"typeIdentifier","preciseIdentifier":"s:Sd","text":"Double"},{"kind":"text","text":")"}],"abstract":[],"identifier":"doc:\/\/ForceSimulation\/documentation\/ForceSimulation\/CenterForce\/apply(alpha:)","kind":"symbol","title":"apply(alpha:)","role":"symbol","type":"topic"},"doc://ForceSimulation/documentation/ForceSimulation":{"identifier":"doc:\/\/ForceSimulation\/documentation\/ForceSimulation","role":"collection","abstract":[],"title":"ForceSimulation","type":"topic","kind":"symbol","url":"\/documentation\/forcesimulation"},"doc://ForceSimulation/documentation/ForceSimulation/CenterForce":{"identifier":"doc:\/\/ForceSimulation\/documentation\/ForceSimulation\/CenterForce","abstract":[{"type":"text","text":"A force that represents links between nodes."}],"fragments":[{"text":"class","kind":"keyword"},{"kind":"text","text":" "},{"text":"CenterForce","kind":"identifier"}],"url":"\/documentation\/forcesimulation\/centerforce","type":"topic","kind":"symbol","title":"CenterForce","role":"symbol","navigatorTitle":[{"text":"CenterForce","kind":"identifier"}]}}}
{"kind":"symbol","sections":[],"abstract":[{"text":"Inherited from ","type":"text"},{"code":"ForceLike.apply(alpha:)","type":"codeVoice"},{"text":".","type":"text"}],"metadata":{"role":"symbol","symbolKind":"method","externalID":"s:15ForceSimulation06CenterA0C5apply5alphaySd_tF","fragments":[{"kind":"keyword","text":"func"},{"text":" ","kind":"text"},{"text":"apply","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"alpha"},{"text":": ","kind":"text"},{"text":"Double","kind":"typeIdentifier","preciseIdentifier":"s:Sd"},{"kind":"text","text":")"}],"title":"apply(alpha:)","roleHeading":"Instance Method","modules":[{"name":"ForceSimulation"}]},"hierarchy":{"paths":[["doc:\/\/ForceSimulation\/documentation\/ForceSimulation","doc:\/\/ForceSimulation\/documentation\/ForceSimulation\/CenterForce"]]},"schemaVersion":{"minor":3,"patch":0,"major":0},"primaryContentSections":[{"kind":"declarations","declarations":[{"platforms":["macOS"],"tokens":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"apply","kind":"identifier"},{"text":"(","kind":"text"},{"kind":"externalParam","text":"alpha"},{"kind":"text","text":": "},{"text":"Double","kind":"typeIdentifier","preciseIdentifier":"s:Sd"},{"kind":"text","text":")"}],"languages":["swift"]}]}],"variants":[{"traits":[{"interfaceLanguage":"swift"}],"paths":["\/documentation\/forcesimulation\/centerforce\/apply(alpha:)"]}],"identifier":{"url":"doc:\/\/ForceSimulation\/documentation\/ForceSimulation\/CenterForce\/apply(alpha:)","interfaceLanguage":"swift"},"references":{"doc://ForceSimulation/documentation/ForceSimulation/CenterForce":{"fragments":[{"text":"class","kind":"keyword"},{"text":" ","kind":"text"},{"kind":"identifier","text":"CenterForce"}],"identifier":"doc:\/\/ForceSimulation\/documentation\/ForceSimulation\/CenterForce","url":"\/documentation\/forcesimulation\/centerforce","kind":"symbol","abstract":[{"type":"text","text":"A force that represents links between nodes."}],"title":"CenterForce","type":"topic","role":"symbol","navigatorTitle":[{"text":"CenterForce","kind":"identifier"}]},"doc://ForceSimulation/documentation/ForceSimulation":{"url":"\/documentation\/forcesimulation","abstract":[],"title":"ForceSimulation","kind":"symbol","identifier":"doc:\/\/ForceSimulation\/documentation\/ForceSimulation","role":"collection","type":"topic"},"doc://ForceSimulation/documentation/ForceSimulation/CenterForce/apply(alpha:)":{"url":"\/documentation\/forcesimulation\/centerforce\/apply(alpha:)","abstract":[],"type":"topic","identifier":"doc:\/\/ForceSimulation\/documentation\/ForceSimulation\/CenterForce\/apply(alpha:)","fragments":[{"text":"func","kind":"keyword"},{"text":" ","kind":"text"},{"text":"apply","kind":"identifier"},{"kind":"text","text":"("},{"kind":"externalParam","text":"alpha"},{"text":": ","kind":"text"},{"text":"Double","kind":"typeIdentifier","preciseIdentifier":"s:Sd"},{"text":")","kind":"text"}],"kind":"symbol","title":"apply(alpha:)","role":"symbol"}}}
Loading