Skip to content

Commit

Permalink
Updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
britzl committed Nov 12, 2019
1 parent 489a671 commit 1802a60
Show file tree
Hide file tree
Showing 37 changed files with 137 additions and 385 deletions.
11 changes: 4 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,9 +1,6 @@
# AdInfo for Defold
# Advertising info for Defold

This is a Defold [native extension](https://www.defold.com/manuals/extensions/) which provides access to AD ID and AD tracking status on iOS and Android devices.
Defold [native extension](https://www.defold.com/manuals/extensions/) which provides access to AD ID and AD tracking status on iOS and Android devices.

To learn more please visit the [documentation page](https://defold.github.io/extension-adinfo/) for this extension.

---

If you have any issues, questions or suggestions please [create an issue](https://github.com/defold/extension-adinfo/issues).
## API and installation
[API and setup instructions](https://defold.github.io/extension-adinfo).
2 changes: 0 additions & 2 deletions docs/Gemfile

This file was deleted.

112 changes: 112 additions & 0 deletions docs/_includes/api_ref.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,112 @@
## Modules
{% for item in site.data.api %}
### <code>{{ item.name }}</code>
{{ item.desc }}
{% endfor %}

## Enums
<table>
<tbody>
{% for module in site.data.api %}
{% for item in module.members %}
{% if item.type contains 'number' %}
<tr>
<td><strong>{{ module.name }}.{{ item.name }}</strong></td>
<td>{{ item.desc | markdownify | replace: "[icon:attention]","<br><br>⚠️"}}</td>
</tr>

{% endif %}
{% endfor %}
{% endfor %}
</tbody>
</table>

<hr>

## Functions
<table>
<tbody>
{% for module in site.data.api %}
{% for item in module.members %}
{% if item.type contains 'function' %}
<tr>
<td><a href="#{{ item.name | url_encode }}"><strong>{{ module.name }}.{{ item.name }}()</strong></a></td>
<td>{{ item.desc | truncate: 80 }}</td>
</tr>
{% endif %}
{% endfor %}
{% endfor %}
</tbody>
</table>

{% for module in site.data.api %}
{% for function in module.members %}
{% if function.type contains 'function' %}
<div class="function-wrap">
<h3 class="function-header"><a href="#{{ function.name | url_encode }}" id="{{ function.name | url_encode }}"><code>{{ module.name }}.{{ function.name }}({% for param in function.parameters %}{{param.name}}{% unless forloop.last %}, {% endunless %}{% endfor %})</code></a></h3>
{% if function.parameters %}
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
{% for param in function.parameters %}
<tr>
<td style="text-align: right;">
<strong>{{ param.name }}</strong>
{% if param.optional %}
(optional)
{% endif %}
</td>
<td><code>{{ param.type }}</code></td>
<td>{{ param.desc | markdownify }}
{% if param.type == "function" %}
{% include type-function.md params=param.parameters %}
{% endif %}
{% if param.type == "table" %}
{% include type-table.md fields=param.members %}
{% endif %}
</td>
</tr>
{% endfor %}
</tbody>
</table>
{% endif %}
{% if function.returns %}
<table>
<thead>
<tr>
<th>Return value</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<h4>Returns</h4>
{% for return in function.returns %}
<tr>
<td>{{ return.name }}</td>
<td><code class="inline-code-block">{{ return.type }}</code></td>
<td>{{ return.desc | markdownify }}</td>
</tr>
{% endfor %}
</tbody>
</table>
{% endif %}
{{ function.desc | markdownify | replace: "[icon:attention]","<br><br>⚠️" | replace: "[type:string]","<code class='inline-code-block'>string</code>" | replace: "[type:number]","<code class='inline-code-block'>number</code>" | replace: "[type:table]","<code class='inline-code-block'>table</code>" | markdownify}}

{% if function.examples %}
<h4>Examples</h4>
{% for example in function.examples %}
{{ example.desc | markdownify }}
{% endfor %}
{% endif %}
</div>

{% endif %}
{% endfor %}
{% endfor %}
38 changes: 0 additions & 38 deletions docs/_includes/description.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/_includes/type-function.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
<tr>
<td><strong>{{ param.name }}</strong></td>
<td><code>{{ param.type }}</code></td>
<td>{% include description.md desc=param.desc %}
<td>{{ param.desc | markdownify }}

{% if param.type == "table" %}
{% include type-table.md fields=param.members %}
Expand Down
2 changes: 1 addition & 1 deletion docs/_includes/type-table.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
{% if field.optional %}
(optional)
{% endif %}
<code>{{ field.type }}</code> - {% include description.md desc=field.desc %}
<code>{{ field.type }}</code> - {{ field.desc | markdownify }}
</li>
{% endfor %}
</ul>
37 changes: 3 additions & 34 deletions docs/_layouts/default.html
Original file line number Diff line number Diff line change
Expand Up @@ -4,49 +4,18 @@
<meta charset="UTF-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="style.css">
<link rel="stylesheet" href="rouge.css">
<link rel="stylesheet" href="fonts.css">
<link rel="stylesheet" href="css/style.css">
<link rel="stylesheet" href="css/rouge.css">
<link rel="stylesheet" href="css/fonts.css">
<!--[if lt IE 9]>
<script src="//cdnjs.cloudflare.com/ajax/libs/html5shiv/3.7.3/html5shiv.min.js"></script>
<![endif]-->
<title>{{ site.title }}</title>
</head>
<body>
<div class="wrapper">
<header>
<h1>Defold ADInfo API documentation</h1>
<p>Function for receiving AD ID and AD tracking status. Supported on iOS and Android.</p>

<p>To use this library in your Defold project, add the following URL to your <code class="inline-code-block">game.project</code> dependencies:
<pre>https://github.com/defold/extension-adinfo/archive/master.zip</pre>
</p>

<p>We recommend using a link to a <code class="inline-code-block">zip</code> file of a <a href="https://github.com/defold/extension-adinfo/releases">specific release</a>.</p>

<p>This extension requires the following dependency (<a href="https://github.com/defold/extension-gps/releases">specific release</a>):
<pre>https://github.com/defold/extension-gps/archive/master.zip</pre>
</p>

<p>The source code can be viewed at: <a href="https://github.com/defold/extension-adinfo">https://github.com/defold/extension-adinfo</a></p>

<p>
<h2>Submitting to the App Store</h2>
When submitting, Apple has three checkboxes for their three valid use cases for the IDFA:
<br>
<br>1. Serve ads within the app
<br>2. Install attribution from ads
<br>3. User action attribution from ads
<br>
<br>If you check option 1, the app reviewer will look for ads to show up in the app. If your game does not show ads, the game might get rejected. Using AdInfo you should check option 2 or 3 depends on how you are using AdInfo extension.
</p>

</header>
<hr>
<section>

{{ content }}

</section>
</div>
</body>
Expand Down
12 changes: 0 additions & 12 deletions docs/fonts.css → docs/css/fonts.css
Original file line number Diff line number Diff line change
Expand Up @@ -53,15 +53,3 @@
url('fonts/Noto-Sans-700italic/Noto-Sans-700italic.ttf') format('truetype'),
url('fonts/Noto-Sans-700italic/Noto-Sans-700italic.svg#NotoSans') format('svg');
}

@font-face {
font-family: fontello;
font-weight: 400;
font-style: normal;
src: url(fonts/fontello/fontello_ef8859ce.eot);
src: url(fonts/fontello/fontello_ef8859ce.eot#iefix) format("embedded-opentype"),
url(fonts/fontello/fontello_248ab5dd.woff2) format("woff2"),
url(fonts/fontello/fontello_b6287553.woff) format("woff"),
url(fonts/fontello/fontello_df5eac8f.ttf) format("truetype"),
url(fonts/fontello/fontello_793be834.svg#fontello) format("svg");
}
133 changes: 0 additions & 133 deletions docs/rouge.css → docs/css/rouge.css
Original file line number Diff line number Diff line change
Expand Up @@ -207,136 +207,3 @@
.highlight {
background-color: #f8f8f8;
}

.icon-amazon:before, .icon-android:before, .icon-apple:before,
.icon-attention:before, .icon-clipboard:before, .icon-clock:before,
.icon-defold:before, .icon-dropbox:before, .icon-facebook:before,
.icon-gameroom:before, .icon-github:before, .icon-googleplay:before,
.icon-html5:before, .icon-instagram:before, .icon-ios:before, .icon-king:before,
.icon-link-ext:before, .icon-link:before, .icon-linux:before, .icon-macos:before,
.icon-search:before, .icon-slack:before, .icon-star:before, .icon-steam:before,
.icon-twitter:before, .icon-windows:before {
font-family: fontello;
font-style: normal;
font-weight: 400;
speak: none;
display: inline-block;
text-decoration: inherit;
width: 1em;
margin-right: .2em;
text-align: center;
font-variant: normal;
text-transform: none;
line-height: 1em;
margin-left: .2em;
-webkit-font-smoothing: antialiased;
-moz-osx-font-smoothing: grayscale
}

.icon-gameroom:before {
content: "\E800"
}

.icon-apple:before {
content: "\E809"
}

.icon-clipboard:before {
content: "\E819"
}

.icon-king:before {
content: "\E858"
}

.icon-defold:before {
content: "\E859"
}

.icon-search:before {
content: "\E86A"
}

.icon-link-ext:before {
content: "\E86F"
}

.icon-link:before {
content: "\E870"
}

.icon-attention:before {
content: "\E871";
color:#ffa500;
}

.icon-amazon:before {
content: "\E872"
}

.icon-android:before {
content: "\E873";
color: #A4C639;
}

.icon-html5:before {
content: "\E875";
color:#f16529;
}

.icon-ios:before {
content: "\E876";
color:#147efb;
}

.icon-linux:before {
content: "\E877"
}

.icon-windows:before {
content: "\E878"
}

.icon-macos:before {
content: "\E87A"
}

.icon-clock:before {
content: "\E87B"
}

.icon-star:before {
content: "\E87C"
}

.icon-googleplay:before {
content: "\E87D"
}

.icon-dropbox:before {
content: "\E87F"
}

.icon-twitter:before {
content: "\E881"
}

.icon-slack:before {
content: "\E883"
}

.icon-instagram:before {
content: "\E884"
}

.icon-steam:before {
content: "\E885"
}

.icon-github:before {
content: "\E886"
}

.icon-facebook:before {
content: "\E887"
}
File renamed without changes.
Empty file modified docs/fonts/Noto-Sans-700/Noto-Sans-700.eot
100755 → 100644
Empty file.
Empty file modified docs/fonts/Noto-Sans-700/Noto-Sans-700.svg
100755 → 100644
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified docs/fonts/Noto-Sans-700/Noto-Sans-700.ttf
100755 → 100644
Empty file.
Empty file modified docs/fonts/Noto-Sans-700/Noto-Sans-700.woff
100755 → 100644
Empty file.
Empty file modified docs/fonts/Noto-Sans-700/Noto-Sans-700.woff2
100755 → 100644
Empty file.
Empty file modified docs/fonts/Noto-Sans-700italic/Noto-Sans-700italic.eot
100755 → 100644
Empty file.
Empty file modified docs/fonts/Noto-Sans-700italic/Noto-Sans-700italic.svg
100755 → 100644
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified docs/fonts/Noto-Sans-700italic/Noto-Sans-700italic.ttf
100755 → 100644
Empty file.
Empty file modified docs/fonts/Noto-Sans-700italic/Noto-Sans-700italic.woff
100755 → 100644
Empty file.
Empty file modified docs/fonts/Noto-Sans-700italic/Noto-Sans-700italic.woff2
100755 → 100644
Empty file.
Empty file modified docs/fonts/Noto-Sans-italic/Noto-Sans-italic.eot
100755 → 100644
Empty file.
Empty file modified docs/fonts/Noto-Sans-italic/Noto-Sans-italic.svg
100755 → 100644
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified docs/fonts/Noto-Sans-italic/Noto-Sans-italic.ttf
100755 → 100644
Empty file.
Empty file modified docs/fonts/Noto-Sans-italic/Noto-Sans-italic.woff
100755 → 100644
Empty file.
Empty file modified docs/fonts/Noto-Sans-italic/Noto-Sans-italic.woff2
100755 → 100644
Empty file.
Empty file modified docs/fonts/Noto-Sans-regular/Noto-Sans-regular.eot
100755 → 100644
Empty file.
Empty file modified docs/fonts/Noto-Sans-regular/Noto-Sans-regular.svg
100755 → 100644
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Empty file modified docs/fonts/Noto-Sans-regular/Noto-Sans-regular.ttf
100755 → 100644
Empty file.
Empty file modified docs/fonts/Noto-Sans-regular/Noto-Sans-regular.woff
100755 → 100644
Empty file.
Empty file modified docs/fonts/Noto-Sans-regular/Noto-Sans-regular.woff2
100755 → 100644
Empty file.
Binary file removed docs/fonts/fontello/fontello_248ab5dd.woff2
Binary file not shown.
Loading

0 comments on commit 1802a60

Please sign in to comment.