-
Notifications
You must be signed in to change notification settings - Fork 193
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
30 changed files
with
2,626 additions
and
25 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,39 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" | ||
| "http://www.apple.com/DTDs/PropertyList-1.0.dtd"> | ||
| <plist version="1.0"> | ||
| <dict> | ||
| <key>--project-name</key> | ||
| <string>Amplitude-iOS</string> | ||
| <key>--project-company</key> | ||
| <string>Amplitude</string> | ||
| <key>--company-id</key> | ||
| <string>com.amplitude</string> | ||
| <key>--templates</key> | ||
| <string>appledoc-templates</string> | ||
|
|
||
| <key>--output</key> | ||
| <string>documentation</string> | ||
|
|
||
| <key>--create-docset</key> | ||
| <false/> | ||
|
|
||
| <key>--create-html</key> | ||
| <true/> | ||
|
|
||
| <key>--ignore</key> | ||
| <array> | ||
| <string>Pods</string> | ||
| <string>documentation</string> | ||
| <string>build</string> | ||
| <string>AmplitudeTests</string> | ||
| <string>AmplitudeFramework</string> | ||
| <string>appledoc-templates</string> | ||
| <string>*.framework</string> | ||
| <string>AMPDatabaseHelper.m</string> | ||
| <string>AMPURLConnection.m</string> | ||
| <string>SSLCertificatePinning</string> | ||
| </array> | ||
|
|
||
| </dict> | ||
| </plist> |
1 change: 1 addition & 0 deletions
1
appledoc-templates/docset/Contents/Resources/Documents/documents-template
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1 @@ | ||
| This is used only as placeholder for location of Documents directory! |
131 changes: 131 additions & 0 deletions
131
appledoc-templates/docset/Contents/Resources/nodes-template.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,131 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <DocSetNodes version="1.0"> | ||
| <TOC> | ||
| <Node type="folder"> | ||
| <Name>{{projectName}}</Name> | ||
| <Path>{{indexFilename}}</Path> | ||
| <Subnodes> | ||
| {{#hasDocs}} | ||
| <Node type="folder"> | ||
| <Name>{{strings.docset.docsTitle}}</Name> | ||
| <Path>{{indexFilename}}</Path> | ||
| <Subnodes> | ||
| {{#docs}}{{>NodeRef}} | ||
| {{/docs}} | ||
| </Subnodes> | ||
| </Node> | ||
| {{/hasDocs}} | ||
| {{#hasClasses}} | ||
| <Node type="folder"> | ||
| <Name>{{strings.docset.classesTitle}}</Name> | ||
| <Path>{{indexFilename}}</Path> | ||
| <Subnodes> | ||
| {{#classes}}{{>NodeRef}} | ||
| {{/classes}} | ||
| </Subnodes> | ||
| </Node> | ||
| {{/hasClasses}} | ||
| {{#hasCategories}} | ||
| <Node> | ||
| <Name>{{strings.docset.categoriesTitle}}</Name> | ||
| <Path>{{indexFilename}}</Path> | ||
| <Subnodes> | ||
| {{#categories}}{{>NodeRef}} | ||
| {{/categories}} | ||
| </Subnodes> | ||
| </Node> | ||
| {{/hasCategories}} | ||
| {{#hasProtocols}} | ||
| <Node> | ||
| <Name>{{strings.docset.protocolsTitle}}</Name> | ||
| <Path>{{indexFilename}}</Path> | ||
| <Subnodes> | ||
| {{#protocols}}{{>NodeRef}} | ||
| {{/protocols}} | ||
| </Subnodes> | ||
| </Node> | ||
| {{/hasProtocols}} | ||
| {{#hasConstants}} | ||
| <Node> | ||
| <Name>{{strings.docset.constantsTitle}}</Name> | ||
| <Path>{{indexFilename}}</Path> | ||
| <Subnodes> | ||
| {{#constants}}{{>NodeRef}} | ||
| {{/constants}} | ||
| </Subnodes> | ||
| </Node> | ||
| {{/hasConstants}} | ||
| {{#hasBlocks}} | ||
| <Node> | ||
| <Name>{{strings.docset.blocksTitle}}</Name> | ||
| <Path>{{indexFilename}}</Path> | ||
| <Subnodes> | ||
| {{#blocks}}{{>NodeRef}} | ||
| {{/blocks}} | ||
| </Subnodes> | ||
| </Node> | ||
| {{/hasBlocks}} | ||
| </Subnodes> | ||
| </Node> | ||
| </TOC> | ||
| <Library> | ||
| {{#docs}}{{>Node}} | ||
| {{/docs}} | ||
| {{#classes}}{{>Node}} | ||
| {{/classes}} | ||
| {{#categories}}{{>Node}} | ||
| {{/categories}} | ||
| {{#protocols}}{{>Node}} | ||
| {{/protocols}} | ||
| {{#constants}}{{>Node}} | ||
| {{/constants}} | ||
| {{#blocks}}{{>Node}} | ||
| {{/blocks}} | ||
| </Library> | ||
| </DocSetNodes> | ||
|
|
||
| Section Node | ||
| <Node id="{{id}}"{{#type}} type="{{type}}"{{/type}}{{#docType}} documentType="{{docType}}"{{/docType}}> | ||
| <Name>{{name}}</Name> | ||
| <Path>{{path}}</Path> | ||
| {{#hasSubNodes}} | ||
| <Subnodes> | ||
| <Node type="section"> | ||
| <Path>{{path}}</Path> | ||
| <Name>Overview</Name> | ||
| <Anchor>overview</Anchor> | ||
| </Node> | ||
| <Node type="section"> | ||
| <Path>{{path}}</Path> | ||
| <Name>Tasks</Name> | ||
| <Anchor>tasks</Anchor> | ||
| </Node> | ||
| {{#hasProperties}} | ||
| <Node type="section"> | ||
| <Path>{{path}}</Path> | ||
| <Name>Properties</Name> | ||
| <Anchor>properties</Anchor> | ||
| </Node> | ||
| {{/hasProperties}} | ||
| {{#hasClassMethods}} | ||
| <Node type="section"> | ||
| <Path>{{path}}</Path> | ||
| <Name>Class Methods</Name> | ||
| <Anchor>class_methods</Anchor> | ||
| </Node> | ||
| {{/hasClassMethods}} | ||
| {{#hasInstanceMethods}} | ||
| <Node type="section"> | ||
| <Path>{{path}}</Path> | ||
| <Name>Instance Methods</Name> | ||
| <Anchor>instance_methods</Anchor> | ||
| </Node> | ||
| {{/hasInstanceMethods}} | ||
| </Subnodes> | ||
| {{/hasSubNodes}} | ||
| </Node> | ||
| EndSection | ||
|
|
||
| Section NodeRef | ||
| <NodeRef refid="{{id}}"/> | ||
| EndSection |
93 changes: 93 additions & 0 deletions
93
appledoc-templates/docset/Contents/Resources/tokens-template.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,93 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <Tokens version="1.0"> | ||
| <File path="{{filePath}}"> | ||
| {{#object}} | ||
| <Token> | ||
| {{>TokenIdentifier}} | ||
| {{>Abstract}} | ||
| {{>DeclaredIn}} | ||
| {{>Availability}} | ||
| {{>RelatedTokens}} | ||
| {{#refid}}<NodeRef refid="{{refid}}"/>{{/refid}} | ||
| </Token> | ||
| {{/object}} | ||
| {{#members}} | ||
| <Token> | ||
| {{>TokenIdentifier}} | ||
| {{>Abstract}} | ||
| {{>DeclaredIn}} | ||
| {{>RelatedTokens}} | ||
| <Declaration>{{>MethodDeclaration}}</Declaration> | ||
| {{#hasParameters}}<Parameters> | ||
| {{#parameters}}<Parameter> | ||
| <Name>{{name}}</Name> | ||
| {{>Abstract}} | ||
| </Parameter>{{/parameters}} | ||
| </Parameters>{{/hasParameters}} | ||
| {{#returnValue}}<ReturnValue>{{>Abstract}}</ReturnValue>{{/returnValue}} | ||
| {{#anchor}}<Anchor>{{anchor}}</Anchor>{{/anchor}} | ||
| {{#refid}}<NodeRef refid="{{refid}}"/>{{/refid}} | ||
| </Token> | ||
| {{/members}} | ||
| {{#constants}} | ||
| <Token> | ||
| {{>TokenIdentifier}} | ||
| {{>Abstract}} | ||
| <Declaration>{{declaration}}</Declaration> | ||
| {{>Availability}} | ||
| {{>DeclaredIn}} | ||
| {{>RelatedTokens}} | ||
| {{>Reference}} | ||
| </Token> | ||
| {{/constants}} | ||
| {{#blocks}} | ||
| <Token> | ||
| {{>TokenIdentifier}} | ||
| {{>Abstract}} | ||
| <Declaration>{{declaration}}</Declaration> | ||
| {{>Availability}} | ||
| {{>DeclaredIn}} | ||
| {{>RelatedTokens}} | ||
| {{>Reference}} | ||
| </Token> | ||
| {{/blocks}} | ||
| </File> | ||
| </Tokens> | ||
|
|
||
| Section TokenIdentifier | ||
| <TokenIdentifier>{{identifier}}</TokenIdentifier> | ||
| EndSection | ||
|
|
||
| Section DeclaredIn | ||
| <DeclaredIn>{{declaredin}}</DeclaredIn> | ||
| EndSection | ||
|
|
||
| Section RelatedTokens | ||
| {{#hasRelatedTokens}} | ||
| <RelatedTokens> | ||
| {{#relatedTokens}}<TokenIdentifier>{{.}}</TokenIdentifier> | ||
| {{/relatedTokens}} | ||
| </RelatedTokens> | ||
| {{/hasRelatedTokens}} | ||
| EndSection | ||
|
|
||
| Section Abstract | ||
| <Abstract type="html">{{#abstract}}{{>GBCommentComponentsList}}{{/abstract}}</Abstract> | ||
| EndSection | ||
|
|
||
| Section Availability | ||
| {{#availability}}<Availability type="html">{{>GBCommentComponentsList}}</Availability>{{/availability}} | ||
| EndSection | ||
|
|
||
| Section Reference | ||
| {{#refid}}<NodeRef refid="{{refid}}"/>{{/refid}} | ||
| EndSection | ||
|
|
||
| Section MethodDeclaration | ||
| {{#formattedComponents}}{{value}}{{/formattedComponents}} | ||
| EndSection | ||
|
|
||
| Section GBCommentComponentsList | ||
| {{#components}}{{textValue}}{{/components}} | ||
| EndSection | ||
|
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,40 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd"> | ||
| <plist version="1.0"> | ||
| <dict> | ||
| <key>CFBundleDevelopmentRegion</key> | ||
| <string>en</string> | ||
| {{#bundleIdentifier}}<key>CFBundleIdentifier</key> | ||
| <string>{{bundleIdentifier}}</string>{{/bundleIdentifier}} | ||
| {{#bundleName}}<key>CFBundleName</key> | ||
| <string>{{bundleName}}</string>{{/bundleName}} | ||
| {{#bundleVersion}}<key>CFBundleShortVersionString</key> | ||
| <string>{{bundleVersion}}</string> | ||
| <key>CFBundleVersion</key> | ||
| <string>{{bundleVersion}}</string>{{/bundleVersion}} | ||
| {{#certificateIssuer}}<key>DocSetCertificateIssuer</key> | ||
| <string>{{certificateIssuer}}</string>{{/certificateIssuer}} | ||
| {{#certificateSigner}}<key>DocSetCertificateSigner</key> | ||
| <string>{{certificateSigner}}</string>{{/certificateSigner}} | ||
| {{#description}}<key>DocSetDescription</key> | ||
| <string>{{description}}</string>{{/description}} | ||
| {{#fallbackURL}}<key>DocSetFallbackURL</key> | ||
| <string>{{fallbackURL}}</string>{{/fallbackURL}} | ||
| {{#feedName}}<key>DocSetFeedName</key> | ||
| <string>{{feedName}}</string>{{/feedName}} | ||
| {{#feedURL}}<key>DocSetFeedURL</key> | ||
| <string>{{feedURL}}</string>{{/feedURL}} | ||
| {{#minimumXcodeVersion}}<key>DocSetMinimumXcodeVersion</key> | ||
| <string>{{minimumXcodeVersion}}</string>{{/minimumXcodeVersion}} | ||
| {{#platformFamily}}<key>DocSetPlatformFamily</key> | ||
| <string>{{platformFamily}}</string>{{/platformFamily}} | ||
| {{#dashPlatformFamily}}<key>DashDocSetFamily</key> | ||
| <string>{{dashPlatformFamily}}</string>{{/dashPlatformFamily}} | ||
| {{#publisherIdentifier}}<key>DocSetPublisherIdentifier</key> | ||
| <string>{{publisherIdentifier}}</string>{{/publisherIdentifier}} | ||
| {{#publisherName}}<key>DocSetPublisherName</key> | ||
| <string>{{publisherName}}</string>{{/publisherName}} | ||
| {{#copyrightMessage}}<key>NSHumanReadableCopyright</key> | ||
| <string>{{copyrightMessage}}</string>{{/copyrightMessage}} | ||
| </dict> | ||
| </plist> |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,17 @@ | ||
| .index-container { | ||
| -webkit-flex-direction: column; | ||
| flex-direction: column; | ||
|
|
||
| @media (min-width: $desktop-min-width) { | ||
| display: flex; | ||
| -webkit-flex-direction: row; | ||
| flex-direction: row; | ||
| -webkit-flex-wrap: wrap; | ||
| flex-wrap: wrap; | ||
| } | ||
|
|
||
| .index-column { | ||
| -webkit-flex: 1 1 33%; | ||
| flex: 1 1 33%; | ||
| } | ||
| } |
Oops, something went wrong.