Merge pull request #23 from esteban-uo/feature/promesify_and_docu
Feature/promesify and docu
1
.gitignore
vendored
@@ -1,3 +1,4 @@
|
||||
node_modules
|
||||
npm-debug.log
|
||||
examples/config.js
|
||||
.DS_Store
|
||||
|
||||
30
.jsdoc.json
Normal file
@@ -0,0 +1,30 @@
|
||||
{
|
||||
"tags": {
|
||||
"allowUnknownTags": true,
|
||||
"dictionaries": [
|
||||
"jsdoc"
|
||||
]
|
||||
},
|
||||
"source": {
|
||||
"include": [
|
||||
"package.json",
|
||||
"README.md"
|
||||
],
|
||||
"includePattern": ".js$",
|
||||
"excludePattern": "(node_modules/|docs)"
|
||||
},
|
||||
"plugins": [],
|
||||
"templates": {
|
||||
"cleverLinks": false,
|
||||
"monospaceLinks": true,
|
||||
"useLongnameInNav": false,
|
||||
"showInheritedInNav": true
|
||||
},
|
||||
"opts": {
|
||||
"destination": "./docs",
|
||||
"encoding": "utf8",
|
||||
"private": true,
|
||||
"recurse": true,
|
||||
"template": "./docs/template"
|
||||
}
|
||||
}
|
||||
@@ -1,3 +1,3 @@
|
||||
language: node_js
|
||||
node_js:
|
||||
- "4.1"
|
||||
- "4.8.7"
|
||||
|
||||
99
README.md
@@ -1,92 +1,27 @@
|
||||
CI
|
||||
--
|
||||
|
||||
[](https://travis-ci.org/esteban-uo/picasa)
|
||||
|
||||
A simple Picasa Web Albums client (2.0) for nodejs. Includes Auth helpers.
|
||||
A simple **Google Photos**, formally **Picasa** Web Albums client (2.0) for nodejs (>= 4.8.7). Includes Auth helpers.
|
||||
|
||||
Install
|
||||
-------
|
||||
<img src="https://www.wptribe.net/wp-content/uploads/2013/01/Picasa_Logo.jpg" />
|
||||
|
||||
### Install
|
||||
```
|
||||
$ yarn add picasa
|
||||
```
|
||||
or
|
||||
```
|
||||
$ npm install --save picasa
|
||||
```
|
||||
|
||||
Usage
|
||||
-----
|
||||
|
||||
(Check out the examples dir too, rename config.example.json > config.json and add your credentials)
|
||||
|
||||
### Usage
|
||||
```js
|
||||
const Picasa = require('picasa')
|
||||
|
||||
const picasa = new Picasa()
|
||||
```
|
||||
|
||||
**NOTE**: Every Picasa API request requires an access token.
|
||||
|
||||
### Photos
|
||||
|
||||
#### Get
|
||||
|
||||
```js
|
||||
|
||||
const options = {
|
||||
maxResults : 10 // by default get all
|
||||
albumId : "6338620891611370881" // by default all photos are selected
|
||||
}
|
||||
|
||||
picasa.getPhotos(accessToken, options, (error, photos) => {
|
||||
console.log(error, photos)
|
||||
})
|
||||
```
|
||||
|
||||
#### Post
|
||||
|
||||
Where binary is the binary's file and the albumId the album id to be stored.
|
||||
|
||||
```js
|
||||
const photoData = {
|
||||
title : 'A title',
|
||||
summary : 'Summary or description',
|
||||
contentType : 'image/jpeg', // image/bmp, image/gif, image/png
|
||||
binary : binary
|
||||
}
|
||||
|
||||
picasa.postPhoto(accessToken, albumId, photoData, (error, photo) => {
|
||||
console.log(error, photo)
|
||||
})
|
||||
```
|
||||
|
||||
#### Delete
|
||||
|
||||
```js
|
||||
picasa.deletePhoto(accessToken, albumId, photoId, (error) => {
|
||||
console.log(error)
|
||||
})
|
||||
```
|
||||
|
||||
### Albums
|
||||
#### Get
|
||||
```js
|
||||
const options = {}
|
||||
|
||||
picasa.getAlbums(accessToken, options, (error, albums) => {
|
||||
console.log(error, albums)
|
||||
})
|
||||
```
|
||||
|
||||
#### Create
|
||||
```js
|
||||
const albumData = {
|
||||
title: 'My first album',
|
||||
summary: 'First album with Picasa API'
|
||||
}
|
||||
|
||||
picasa.createAlbum(accessToken, albumData, (error, albums) => {
|
||||
console.log(error, albums)
|
||||
})
|
||||
```
|
||||
### Docs
|
||||
API for Photos, Albums and Auth can be found [here](./docs). Please check out also the examples dir for more detailed examples. Rename `config.example.json` to `config.json` and add your own config data.
|
||||
|
||||
### Auth
|
||||
|
||||
@@ -118,12 +53,12 @@ const config = {
|
||||
clientSecret : 'yourClientSecret'
|
||||
}
|
||||
|
||||
picasa.getAccessToken(config, code, (error, accessToken, refreshToken) => {
|
||||
console.log(error, accessToken, refreshToken)
|
||||
picasa.getTokens(config, code).then(tokens => {
|
||||
/* use tokens.accessToken or tokens.refreshToken */
|
||||
})
|
||||
```
|
||||
|
||||
5.If you need to renew an expired `accessToken` use the `refreshToken` with `renewAccessToken`:
|
||||
5.If you need to renew an expired `accessToken`, use the `refreshToken` with `picasa.renewAccessToken`:
|
||||
|
||||
```js
|
||||
const config = {
|
||||
@@ -132,14 +67,16 @@ const config = {
|
||||
clientSecret : 'yourClientSecret'
|
||||
}
|
||||
|
||||
picasa.renewAccessToken(config, refreshToken, (error, accessToken) => {
|
||||
console.log(error, accessToken)
|
||||
picasa.renewAccessToken(config, refreshToken).then(renewedAccessToken => {
|
||||
/* do something with renewedAccessToken */
|
||||
})
|
||||
```
|
||||
|
||||
Change Log
|
||||
-------
|
||||
***16/05/2017***: Get album, Create Album, Renew access token added. Get Photos can get all photos from an album id or all.
|
||||
***1.0.7*** Functions return a Promise if callback is not provided. Use `getTokens` if you want to use Promises instead `getAccessToken`.
|
||||
|
||||
***1.0.6*** Get album, Create Album, Renew access token added. Get Photos can get all photos from an album id or all.
|
||||
|
||||
Contributors
|
||||
-------
|
||||
|
||||
2493
docs/Picasa.html
Normal file
BIN
docs/fonts/OpenSans-Bold-webfont.eot
Normal file
1830
docs/fonts/OpenSans-Bold-webfont.svg
Normal file
|
After Width: | Height: | Size: 116 KiB |
BIN
docs/fonts/OpenSans-Bold-webfont.woff
Normal file
BIN
docs/fonts/OpenSans-BoldItalic-webfont.eot
Normal file
1830
docs/fonts/OpenSans-BoldItalic-webfont.svg
Normal file
|
After Width: | Height: | Size: 118 KiB |
BIN
docs/fonts/OpenSans-BoldItalic-webfont.woff
Normal file
BIN
docs/fonts/OpenSans-Italic-webfont.eot
Normal file
1830
docs/fonts/OpenSans-Italic-webfont.svg
Normal file
|
After Width: | Height: | Size: 120 KiB |
BIN
docs/fonts/OpenSans-Italic-webfont.woff
Normal file
BIN
docs/fonts/OpenSans-Light-webfont.eot
Normal file
1831
docs/fonts/OpenSans-Light-webfont.svg
Normal file
|
After Width: | Height: | Size: 114 KiB |
BIN
docs/fonts/OpenSans-Light-webfont.woff
Normal file
BIN
docs/fonts/OpenSans-LightItalic-webfont.eot
Normal file
1835
docs/fonts/OpenSans-LightItalic-webfont.svg
Normal file
|
After Width: | Height: | Size: 120 KiB |
BIN
docs/fonts/OpenSans-LightItalic-webfont.woff
Normal file
BIN
docs/fonts/OpenSans-Regular-webfont.eot
Normal file
1831
docs/fonts/OpenSans-Regular-webfont.svg
Normal file
|
After Width: | Height: | Size: 117 KiB |
BIN
docs/fonts/OpenSans-Regular-webfont.woff
Normal file
BIN
docs/fonts/OpenSans-Semibold-webfont.eot
Normal file
1830
docs/fonts/OpenSans-Semibold-webfont.svg
Normal file
|
After Width: | Height: | Size: 116 KiB |
BIN
docs/fonts/OpenSans-Semibold-webfont.ttf
Normal file
BIN
docs/fonts/OpenSans-Semibold-webfont.woff
Normal file
BIN
docs/fonts/OpenSans-SemiboldItalic-webfont.eot
Normal file
1830
docs/fonts/OpenSans-SemiboldItalic-webfont.svg
Normal file
|
After Width: | Height: | Size: 120 KiB |
BIN
docs/fonts/OpenSans-SemiboldItalic-webfont.ttf
Normal file
BIN
docs/fonts/OpenSans-SemiboldItalic-webfont.woff
Normal file
453
docs/global.html
Normal file
@@ -0,0 +1,453 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<title>Global - Documentation</title>
|
||||
|
||||
<script src="scripts/prettify/prettify.js"></script>
|
||||
<script src="scripts/prettify/lang-css.js"></script>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
||||
<![endif]-->
|
||||
<link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
|
||||
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
||||
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
|
||||
<label for="nav-trigger" class="navicon-button x">
|
||||
<div class="navicon"></div>
|
||||
</label>
|
||||
|
||||
<label for="nav-trigger" class="overlay"></label>
|
||||
|
||||
<nav>
|
||||
<li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading">Classes</li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Picasa.html">Picasa</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#createAlbum">createAlbum</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#deletePhoto">deletePhoto</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#getAlbums">getAlbums</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#getAuthURL">getAuthURL</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#getPhotos">getPhotos</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#getTokens">getTokens</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#postPhoto">postPhoto</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#renewAccessToken">renewAccessToken</a></span></li><li class="nav-heading"><a href="global.html">Globals</a></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#getAccessToken">getAccessToken</a></span></li>
|
||||
</nav>
|
||||
|
||||
<div id="main">
|
||||
|
||||
<h1 class="page-title">Global</h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section>
|
||||
|
||||
<header>
|
||||
|
||||
<h2>
|
||||
|
||||
</h2>
|
||||
|
||||
|
||||
</header>
|
||||
|
||||
<article>
|
||||
<div class="container-overview">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="details">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 class="subsection-title">Methods</h3>
|
||||
|
||||
|
||||
|
||||
<div class="section-method">
|
||||
|
||||
|
||||
|
||||
<h4 class="name" id="getAccessToken"><span class="type-signature"></span>getAccessToken<span class="signature">(config, code, callback)</span><span class="type-signature"> → {Promise}</span></h4>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="description">
|
||||
Get access token. To be deprecated soon. Use <a href="Picasa.html#getTokens"><code>Picasa#getTokens</code></a> instead
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="details">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="picasa.js.html">picasa.js</a>, <a href="picasa.js.html#line362">line 362</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h5>Parameters:</h5>
|
||||
|
||||
|
||||
<table class="params">
|
||||
<thead>
|
||||
<tr>
|
||||
|
||||
<th>Name</th>
|
||||
|
||||
|
||||
<th>Type</th>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<th class="last">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
|
||||
<tbody>
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>config</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type"><code>object</code></span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last">
|
||||
Get config here: <a href="https://console.developers.google.com/home/dashboard">https://console.developers.google.com/home/dashboard</a> (API Manager > Credentials)
|
||||
|
||||
|
||||
|
||||
<table class="params">
|
||||
<thead>
|
||||
<tr>
|
||||
|
||||
<th>Name</th>
|
||||
|
||||
|
||||
<th>Type</th>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<th class="last">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
|
||||
<tbody>
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>clientId</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type"><code>string</code></span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last">
|
||||
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>redirectURI</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type"><code>string</code></span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last">
|
||||
URL that user was redirected. After google displays a consent screen to the user, user will be redirect to this URL with a `code` in the URL
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>clientSecret</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type"><code>string</code></span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last">
|
||||
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>code</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type"><code>string</code></span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last">
|
||||
Get code from URL param, when user is redirected from authURL. See <a href="Picasa.html#getAuthURL"><code>Picasa#getAuthURL</code></a>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>callback</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type"><code>function</code></span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last">
|
||||
(error, response{accessToken, refreshToken}). If not provided, a promise will be returned
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="section-returns">
|
||||
<h5>Returns:</h5>
|
||||
|
||||
|
||||
|
||||
<dl class="param-type">
|
||||
<dt>
|
||||
Type:
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<span class="param-type"><code>Promise</code></span>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
<div class="param-desc">
|
||||
- String accessToken
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<br class="clear">
|
||||
|
||||
<footer>
|
||||
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Mar 04 2018 20:34:29 GMT+0100 (CET) using the Minami theme.
|
||||
</footer>
|
||||
|
||||
<script>prettyPrint();</script>
|
||||
<script src="scripts/linenumber.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
113
docs/index.html
Normal file
@@ -0,0 +1,113 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<title>Home - Documentation</title>
|
||||
|
||||
<script src="scripts/prettify/prettify.js"></script>
|
||||
<script src="scripts/prettify/lang-css.js"></script>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
||||
<![endif]-->
|
||||
<link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
|
||||
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
||||
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
|
||||
<label for="nav-trigger" class="navicon-button x">
|
||||
<div class="navicon"></div>
|
||||
</label>
|
||||
|
||||
<label for="nav-trigger" class="overlay"></label>
|
||||
|
||||
<nav>
|
||||
<li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading">Classes</li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Picasa.html">Picasa</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#createAlbum">createAlbum</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#deletePhoto">deletePhoto</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#getAlbums">getAlbums</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#getAuthURL">getAuthURL</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#getPhotos">getPhotos</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#getTokens">getTokens</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#postPhoto">postPhoto</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#renewAccessToken">renewAccessToken</a></span></li><li class="nav-heading"><a href="global.html">Globals</a></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#getAccessToken">getAccessToken</a></span></li>
|
||||
</nav>
|
||||
|
||||
<div id="main">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section class="readme">
|
||||
<article><p><a href="https://travis-ci.org/esteban-uo/picasa"><img src="https://travis-ci.org/esteban-uo/picasa.svg" alt="Build Status"></a></p>
|
||||
<p>A simple <strong>Google Photos</strong>, formally <strong>Picasa</strong> Web Albums client (2.0) for nodejs (>= 4.8.7). Includes Auth helpers.</p>
|
||||
<p><img src="https://www.wptribe.net/wp-content/uploads/2013/01/Picasa_Logo.jpg" /></p>
|
||||
<h3>Install</h3><pre class="prettyprint source"><code>$ yarn add picasa</code></pre><p>or</p>
|
||||
<pre class="prettyprint source"><code>$ npm install --save picasa</code></pre><h3>Usage</h3><pre class="prettyprint source lang-js"><code>const Picasa = require('picasa')
|
||||
|
||||
const picasa = new Picasa()</code></pre><h3>Docs</h3><p>API for Photos, Albums and Auth can be found <a href="./docs">here</a>. Please check out also the examples dir for more detailed examples. Rename <code>config.example.json</code> to <code>config.json</code> and add your own config data.</p>
|
||||
<h3>Auth</h3><p>To get an access token follow the next flow:</p>
|
||||
<p>1.Get the Auth URL and redirect the user to it.</p>
|
||||
<pre class="prettyprint source lang-js"><code>// Get config here API Manager > Credentials https://console.developers.google.com/home/dashboard
|
||||
const config = {
|
||||
clientId : 'yourClientId',
|
||||
redirectURI : 'redirectURI'
|
||||
}
|
||||
|
||||
const authURL = picasa.getAuthURL(config)</code></pre><p>2.Google displays a consent screen to the user, asking them to authorize your application to request some of their data.</p>
|
||||
<p>3.Google redirects a code to your redirectURI.</p>
|
||||
<p>4.Use the code given as GET param in order to get an access token:</p>
|
||||
<pre class="prettyprint source lang-js"><code>// Get config here API Manager > Credentials https://console.developers.google.com/home/dashboard
|
||||
const config = {
|
||||
clientId : 'yourClientId',
|
||||
redirectURI : 'redirectURI'
|
||||
clientSecret : 'yourClientSecret'
|
||||
}
|
||||
|
||||
picasa.getTokens(config, code).then(tokens => {
|
||||
/* use tokens.accessToken or tokens.refreshToken */
|
||||
})</code></pre><p>5.If you need to renew an expired <code>accessToken</code>, use the <code>refreshToken</code> with <code>picasa.renewAccessToken</code>:</p>
|
||||
<pre class="prettyprint source lang-js"><code>const config = {
|
||||
clientId : 'yourClientId',
|
||||
redirectURI : 'redirectURI'
|
||||
clientSecret : 'yourClientSecret'
|
||||
}
|
||||
|
||||
picasa.renewAccessToken(config, refreshToken).then(renewedAccessToken => {
|
||||
/* do something with renewedAccessToken */
|
||||
})</code></pre><h2>Change Log</h2><p><strong><em>1.0.7</em></strong> Functions return a Promise if callback is not provided. Use <code>getTokens</code> if you want to use Promises instead <code>getAccessToken</code>.</p>
|
||||
<p><strong><em>1.0.6</em></strong> Get album, Create Album, Renew access token added. Get Photos can get all photos from an album id or all.</p>
|
||||
<h2>Contributors</h2><p>Thanks to
|
||||
<a href="https://github.com/z1c0">z1c0</a>, <a href="https://github.com/hbakhtiyor">hbakhtiyor</a>, <a href="https://github.com/pauarge">pauarge</a>, <a href="https://github.com/wreuven">wreuven</a></p>
|
||||
<h2>License</h2><p>MIT ©</p>
|
||||
<hr>
|
||||
<p>Play around https://developers.google.com/oauthplayground/?code=4/usq8QmuezR3Au_0UKyj9-UXmf6Bw_ij8KFWgIziYbpM#</p>
|
||||
<p>Picasa Docs https://developers.google.com/picasa-web/docs/2.0/developers_guide_protocol</p></article>
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<br class="clear">
|
||||
|
||||
<footer>
|
||||
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Mar 04 2018 20:34:29 GMT+0100 (CET) using the Minami theme.
|
||||
</footer>
|
||||
|
||||
<script>prettyPrint();</script>
|
||||
<script src="scripts/linenumber.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
487
docs/picasa.js.html
Normal file
@@ -0,0 +1,487 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<title>picasa.js - Documentation</title>
|
||||
|
||||
<script src="scripts/prettify/prettify.js"></script>
|
||||
<script src="scripts/prettify/lang-css.js"></script>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
||||
<![endif]-->
|
||||
<link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
|
||||
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
||||
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
|
||||
<label for="nav-trigger" class="navicon-button x">
|
||||
<div class="navicon"></div>
|
||||
</label>
|
||||
|
||||
<label for="nav-trigger" class="overlay"></label>
|
||||
|
||||
<nav>
|
||||
<li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading">Classes</li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Picasa.html">Picasa</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#createAlbum">createAlbum</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#deletePhoto">deletePhoto</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#getAlbums">getAlbums</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#getAuthURL">getAuthURL</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#getPhotos">getPhotos</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#getTokens">getTokens</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#postPhoto">postPhoto</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#renewAccessToken">renewAccessToken</a></span></li><li class="nav-heading"><a href="global.html">Globals</a></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#getAccessToken">getAccessToken</a></span></li>
|
||||
</nav>
|
||||
|
||||
<div id="main">
|
||||
|
||||
<h1 class="page-title">picasa.js</h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section>
|
||||
<article>
|
||||
<pre class="prettyprint source linenums"><code>'use strict'
|
||||
|
||||
const querystring = require('querystring')
|
||||
|
||||
const promisify = require('./promisify')
|
||||
const executeRequest = require('./executeRequest')
|
||||
|
||||
const GOOGLE_AUTH_ENDPOINT = 'https://accounts.google.com/o/oauth2/auth'
|
||||
const GOOGLE_API_HOST = 'https://www.googleapis.com'
|
||||
const GOOGLE_API_PATH = '/oauth2/v3/token'
|
||||
const GOOGLE_API_PATH_NEW = '/oauth2/v4/token'
|
||||
|
||||
const PICASA_SCOPE = 'https://picasaweb.google.com/data'
|
||||
const PICASA_API_FEED_PATH = '/feed/api/user/default'
|
||||
const PICASA_API_ENTRY_PATH = '/entry/api/user/default'
|
||||
|
||||
const FETCH_AS_JSON = 'json'
|
||||
|
||||
/** Main class */
|
||||
class Picasa {
|
||||
/**
|
||||
* Creates an instance of Picasa.
|
||||
*/
|
||||
constructor() {
|
||||
this.executeRequest = executeRequest
|
||||
this.getAccessToken = getAccessToken.bind(this)
|
||||
}
|
||||
|
||||
/**
|
||||
* Get Photos
|
||||
* @param {string} accessToken - See {@link Picasa#getTokens}
|
||||
* @param {object} options - Can be empty object
|
||||
* @param {integer} options.maxResults - By default get all photos
|
||||
* @param {string} options.albumId - By default all photos are selected
|
||||
* @param {function} callback - (error, response). If not provided, a promise will be returned
|
||||
* @returns {Promise}
|
||||
*/
|
||||
getPhotos() {
|
||||
return promisify.bind(this)(getPhotos, arguments)
|
||||
}
|
||||
|
||||
/**
|
||||
* Create Photos
|
||||
* @param {string} accessToken - See {@link Picasa#getTokens}
|
||||
* @param {string} albumId
|
||||
* @param {object} photoData - Photo's propperties
|
||||
* @param {string} photoData.title
|
||||
* @param {string} photoData.summary
|
||||
* @param {string} photoData.contentType - image/bmp, image/gif, image/png
|
||||
* @param {blob} photoData.binary - Blob binary
|
||||
* @param {function} callback - (error, response). If not provided, a promise will be returned
|
||||
* @returns {Promise}
|
||||
*/
|
||||
postPhoto() {
|
||||
return promisify.bind(this)(postPhoto, arguments)
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete Photo
|
||||
* @param {string} accessToken - See {@link Picasa#getTokens}
|
||||
* @param {string} albumId
|
||||
* @param {string} photoId
|
||||
* @param {function} callback - (error, response). If not provided, a promise will be returned
|
||||
* @returns {Promise}
|
||||
*/
|
||||
deletePhoto() {
|
||||
return promisify.bind(this)(deletePhoto, arguments)
|
||||
}
|
||||
|
||||
/**
|
||||
* Get all Albums
|
||||
* @param {string} accessToken - See {@link Picasa#getTokens}
|
||||
* @param {object} options - Can be empty object
|
||||
* @param {integer} options.TODO - TODO
|
||||
* @param {function} callback - (error, response). If not provided, a promise will be returned
|
||||
* @returns {Promise}
|
||||
*/
|
||||
getAlbums() {
|
||||
return promisify.bind(this)(getAlbums, arguments)
|
||||
}
|
||||
|
||||
/**
|
||||
* Create an albums
|
||||
* @param {string} accessToken - See {@link Picasa#getTokens}
|
||||
* @param {object} albumData - Can be empty object
|
||||
* @param {string} albumData.title
|
||||
* @param {string} albumData.summary
|
||||
* @param {function} callback - (error, response). If not provided, a promise will be returned
|
||||
* @returns {Promise}
|
||||
*/
|
||||
createAlbum() {
|
||||
return promisify.bind(this)(createAlbum, arguments)
|
||||
}
|
||||
|
||||
/**
|
||||
* Get access token and refresh token
|
||||
* @param {object} config - Get config here: {@link https://console.developers.google.com/home/dashboard} (API Manager > Credentials)
|
||||
* @param {string} config.clientId
|
||||
* @param {string} config.redirectURI - URL that user was redirected. After google displays a consent screen to the user, user will be redirect to this URL with a `code` in the URL
|
||||
* @param {string} config.clientSecret
|
||||
* @param {string} code - Get code from URL param, when user is redirected from authURL. See {@link Picasa#getAuthURL}
|
||||
* @param {function} callback - (error, response{accessToken, refreshToken}). If not provided, a promise will be returned
|
||||
* @returns {Promise} - Object{accessToken, refreshToken}
|
||||
*/
|
||||
getTokens() {
|
||||
return promisify.bind(this)(getTokens, arguments)
|
||||
}
|
||||
|
||||
/**
|
||||
* Renews access token
|
||||
* @param {object} config - Get config here: {@link https://console.developers.google.com/home/dashboard} (API Manager > Credentials)
|
||||
* @param {string} config.clientId
|
||||
* @param {string} config.redirectURI - URL that user was redirected. After google displays a consent screen to the user, user will be redirect to this URL with a `code` in the URL
|
||||
* @param {string} config.clientSecret
|
||||
* @param {string} refreshToken - The refreshToken is retrived after getTokens is executed. See {@link Picasa#getTokens}
|
||||
* @param {function} callback - (error, response). If not provided, a promise will be returned
|
||||
* @returns {Promise}
|
||||
*/
|
||||
renewAccessToken() {
|
||||
return promisify.bind(this)(renewAccessToken, arguments)
|
||||
}
|
||||
|
||||
/**
|
||||
* Get Auth URL. Redirect user to this URL to get code. The code will be used later for {@link Picasa#getTokens}
|
||||
* @param {object} config - Get config here: https://console.developers.google.com/home/dashboard (API Manager > Credentials)
|
||||
* @param {string} config.clientId
|
||||
* @param {string} config.redirectURI - URL to user will be redirected. After google displays a consent screen to the user, user will be redirect to this URL with a `code` in the URL
|
||||
* @param {function} callback - (error, response). If not provided, a promise will be returned
|
||||
* @returns {Promise}
|
||||
*/
|
||||
getAuthURL(config) {
|
||||
const authenticationParams = {
|
||||
access_type: 'offline',
|
||||
scope: `${PICASA_SCOPE}`,
|
||||
response_type: 'code',
|
||||
client_id: config.clientId,
|
||||
redirect_uri: config.redirectURI
|
||||
}
|
||||
|
||||
const authenticationQuery = querystring.stringify(authenticationParams)
|
||||
|
||||
return `${GOOGLE_AUTH_ENDPOINT}?${authenticationQuery}`
|
||||
}
|
||||
}
|
||||
|
||||
function getAlbums(accessToken, options, callback) {
|
||||
const accessTokenParams = {
|
||||
alt: FETCH_AS_JSON,
|
||||
access_token: accessToken
|
||||
}
|
||||
|
||||
options = options || {}
|
||||
|
||||
const requestQuery = querystring.stringify(accessTokenParams)
|
||||
|
||||
const requestOptions = {
|
||||
url: `${PICASA_SCOPE}${PICASA_API_FEED_PATH}?${requestQuery}`,
|
||||
headers: {
|
||||
'GData-Version': '2'
|
||||
}
|
||||
}
|
||||
|
||||
this.executeRequest('get', requestOptions, (error, body) => {
|
||||
if (error) return callback(error)
|
||||
|
||||
const albums = body.feed.entry.map(
|
||||
entry => parseEntry(entry, albumSchema)
|
||||
)
|
||||
callback(null, albums)
|
||||
})
|
||||
}
|
||||
|
||||
function deletePhoto(accessToken, albumId, photoId, callback) {
|
||||
const requestQuery = querystring.stringify({
|
||||
alt: FETCH_AS_JSON,
|
||||
access_token: accessToken
|
||||
})
|
||||
|
||||
const requestOptions = {
|
||||
url: `${PICASA_SCOPE}${PICASA_API_ENTRY_PATH}/albumid/${albumId}/photoid/${photoId}?${requestQuery}`,
|
||||
headers: {
|
||||
'If-Match': '*'
|
||||
}
|
||||
}
|
||||
|
||||
this.executeRequest('del', requestOptions, callback)
|
||||
}
|
||||
|
||||
function createAlbum(accessToken, albumData, callback) {
|
||||
const requestQuery = querystring.stringify({
|
||||
alt: FETCH_AS_JSON,
|
||||
access_token: accessToken
|
||||
})
|
||||
|
||||
const albumInfoAtom = `<entry xmlns='http://www.w3.org/2005/Atom'
|
||||
xmlns:media='http://search.yahoo.com/mrss/'
|
||||
xmlns:gphoto='http://schemas.google.com/photos/2007'>
|
||||
<title type='text'>${albumData.title}</title>
|
||||
<summary type='text'>${albumData.summary}</summary>
|
||||
<gphoto:access>private</gphoto:access>
|
||||
<category scheme='http://schemas.google.com/g/2005#kind'
|
||||
term='http://schemas.google.com/photos/2007#album'></category>
|
||||
</entry>`
|
||||
|
||||
const requestOptions = {
|
||||
url: `${PICASA_SCOPE}${PICASA_API_FEED_PATH}?${requestQuery}`,
|
||||
body: albumInfoAtom,
|
||||
headers: { 'Content-Type': 'application/atom+xml' }
|
||||
}
|
||||
|
||||
this.executeRequest('post', requestOptions, (error, body) => {
|
||||
if (error) return callback(error)
|
||||
|
||||
const album = parseEntry(body.entry, albumSchema)
|
||||
|
||||
callback(error, album)
|
||||
})
|
||||
}
|
||||
|
||||
function postPhoto(accessToken, albumId, photoData, callback) {
|
||||
const requestQuery = querystring.stringify({
|
||||
alt: FETCH_AS_JSON,
|
||||
access_token: accessToken
|
||||
})
|
||||
|
||||
const photoInfoAtom = `<entry xmlns="http://www.w3.org/2005/Atom">
|
||||
<title>${photoData.title}</title>
|
||||
<summary>${photoData.summary}</summary>
|
||||
<category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/photos/2007#photo"/>
|
||||
</entry>`
|
||||
|
||||
const requestOptions = {
|
||||
url: `${PICASA_SCOPE}${PICASA_API_FEED_PATH}/albumid/${albumId}?${requestQuery}`,
|
||||
multipart: [
|
||||
{ 'Content-Type': 'application/atom+xml', body: photoInfoAtom },
|
||||
{ 'Content-Type': photoData.contentType, body: photoData.binary }
|
||||
]
|
||||
}
|
||||
|
||||
this.executeRequest('post', requestOptions, (error, body) => {
|
||||
if (error) return callback(error)
|
||||
|
||||
const photo = parseEntry(body.entry, photoSchema)
|
||||
|
||||
callback(error, photo)
|
||||
})
|
||||
}
|
||||
|
||||
function getPhotos(accessToken, options, callback) {
|
||||
const accessTokenParams = {
|
||||
alt: FETCH_AS_JSON,
|
||||
kind: 'photo',
|
||||
access_token: accessToken
|
||||
}
|
||||
|
||||
options = options || {}
|
||||
|
||||
if (options.maxResults) accessTokenParams['max-results'] = options.maxResults
|
||||
if (options.startIndex) accessTokenParams['start-index'] = options.startIndex
|
||||
if (options.imgMax) accessTokenParams['imgmax'] = options.imgMax
|
||||
|
||||
const albumPart = options.albumId ? `/albumid/${options.albumId}` : ''
|
||||
|
||||
const requestQuery = querystring.stringify(accessTokenParams)
|
||||
|
||||
const requestOptions = {
|
||||
url: `${PICASA_SCOPE}${PICASA_API_FEED_PATH}${albumPart}?${requestQuery}`,
|
||||
headers: {
|
||||
'GData-Version': '2'
|
||||
}
|
||||
}
|
||||
|
||||
this.executeRequest('get', requestOptions, (error, body) => {
|
||||
if (error) return callback(error)
|
||||
|
||||
const photos = body.feed.entry.map(
|
||||
entry => parseEntry(entry, photoSchema)
|
||||
)
|
||||
|
||||
callback(null, photos)
|
||||
})
|
||||
}
|
||||
|
||||
const albumSchema = {
|
||||
'media$group.media$thumbnail': 'thumbnail',
|
||||
'gphoto$id': 'id',
|
||||
'gphoto$name': 'name',
|
||||
'gphoto$numphotos': 'num_photos',
|
||||
'published': 'published',
|
||||
'title': 'title',
|
||||
'summary': 'summary',
|
||||
'gphoto$location': 'location',
|
||||
'gphoto$nickname': 'nickname',
|
||||
'rights': 'rights',
|
||||
'gphoto$access': 'access'
|
||||
}
|
||||
|
||||
const photoSchema = {
|
||||
'gphoto$id': 'id',
|
||||
'gphoto$albumid': 'album_id',
|
||||
'gphoto$access': 'access',
|
||||
'gphoto$width': 'width',
|
||||
'gphoto$height': 'height',
|
||||
'gphoto$size': 'size',
|
||||
'gphoto$checksum': 'checksum',
|
||||
'gphoto$timestamp': 'timestamp',
|
||||
'gphoto$imageVersion': 'image_version',
|
||||
'gphoto$commentingEnabled': 'commenting_enabled',
|
||||
'gphoto$commentCount': 'comment_count',
|
||||
'content': 'content',
|
||||
'title': 'title',
|
||||
'summary': 'summary'
|
||||
}
|
||||
|
||||
function parseEntry(entry, schema) {
|
||||
let photo = {}
|
||||
|
||||
Object.keys(schema).forEach(schemaKey => {
|
||||
const key = schema[schemaKey]
|
||||
|
||||
if (key) {
|
||||
const value = extractValue(entry, schemaKey, key)
|
||||
photo[key] = value
|
||||
}
|
||||
})
|
||||
|
||||
return photo
|
||||
}
|
||||
|
||||
function extractValue(entry, schemaKey) {
|
||||
if (schemaKey.indexOf('.') !== -1) {
|
||||
const tempKey = schemaKey.split('.')[0]
|
||||
return extractValue(checkParam(entry[tempKey]), schemaKey.replace(`${tempKey}.`, ''))
|
||||
}
|
||||
return checkParam(entry[schemaKey])
|
||||
}
|
||||
|
||||
function getAuthURL(config) {
|
||||
const authenticationParams = {
|
||||
access_type: 'offline',
|
||||
scope: `${PICASA_SCOPE}`,
|
||||
response_type: 'code',
|
||||
client_id: config.clientId,
|
||||
redirect_uri: config.redirectURI
|
||||
}
|
||||
|
||||
const authenticationQuery = querystring.stringify(authenticationParams)
|
||||
|
||||
return `${GOOGLE_AUTH_ENDPOINT}?${authenticationQuery}`
|
||||
}
|
||||
|
||||
/**
|
||||
* Get access token. To be deprecated soon. Use {@link Picasa#getTokens} instead
|
||||
* @param {object} config - Get config here: {@link https://console.developers.google.com/home/dashboard} (API Manager > Credentials)
|
||||
* @param {string} config.clientId
|
||||
* @param {string} config.redirectURI - URL that user was redirected. After google displays a consent screen to the user, user will be redirect to this URL with a `code` in the URL
|
||||
* @param {string} config.clientSecret
|
||||
* @param {string} code - Get code from URL param, when user is redirected from authURL. See {@link Picasa#getAuthURL}
|
||||
* @param {function} callback - (error, response{accessToken, refreshToken}). If not provided, a promise will be returned
|
||||
* @returns {Promise} - String accessToken
|
||||
*/
|
||||
function getAccessToken(config, code, callback) {
|
||||
const accessTokenParams = {
|
||||
grant_type: 'authorization_code',
|
||||
code: code,
|
||||
redirect_uri: config.redirectURI,
|
||||
client_id: config.clientId,
|
||||
client_secret: config.clientSecret
|
||||
}
|
||||
|
||||
const requestQuery = querystring.stringify(accessTokenParams)
|
||||
const options = {
|
||||
url: `${GOOGLE_API_HOST}${GOOGLE_API_PATH}?${requestQuery}`
|
||||
}
|
||||
|
||||
this.executeRequest('post', options, (error, body) => {
|
||||
if (error) return callback(error)
|
||||
|
||||
callback(null, body.access_token, body.refresh_token)
|
||||
})
|
||||
}
|
||||
|
||||
function getTokens(config, code, callback) {
|
||||
return getAccessToken(config, code, (error, accessToken, refreshToken) => {
|
||||
if (error) return callback(error)
|
||||
|
||||
const tokens = {
|
||||
accessToken,
|
||||
refreshToken,
|
||||
}
|
||||
|
||||
callback(null, tokens)
|
||||
})
|
||||
}
|
||||
|
||||
function renewAccessToken(config, refresh_token, callback) {
|
||||
const refreshTokenParams = {
|
||||
grant_type: 'refresh_token',
|
||||
client_id: config.clientId,
|
||||
client_secret: config.clientSecret,
|
||||
refresh_token: refresh_token
|
||||
}
|
||||
|
||||
const requestQuery = querystring.stringify(refreshTokenParams)
|
||||
const options = {
|
||||
url: `${GOOGLE_API_HOST}${GOOGLE_API_PATH_NEW}?${requestQuery}`
|
||||
}
|
||||
|
||||
this.executeRequest('post', options, (error, body) => {
|
||||
if (error) return callback(error)
|
||||
|
||||
callback(null, body.access_token)
|
||||
})
|
||||
}
|
||||
|
||||
function checkParam(param) {
|
||||
if (param === undefined) return ''
|
||||
else if (isValidType(param)) return param
|
||||
else if (isValidType(param['$t'])) return param['$t']
|
||||
else return param
|
||||
}
|
||||
|
||||
function isValidType(value) {
|
||||
return typeof value === 'string' || typeof value === 'number'
|
||||
}
|
||||
|
||||
module.exports = Picasa
|
||||
</code></pre>
|
||||
</article>
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<br class="clear">
|
||||
|
||||
<footer>
|
||||
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Mar 04 2018 20:34:29 GMT+0100 (CET) using the Minami theme.
|
||||
</footer>
|
||||
|
||||
<script>prettyPrint();</script>
|
||||
<script src="scripts/linenumber.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
2493
docs/picasa/1.0.7/Picasa.html
Normal file
BIN
docs/picasa/1.0.7/fonts/OpenSans-Bold-webfont.eot
Normal file
1830
docs/picasa/1.0.7/fonts/OpenSans-Bold-webfont.svg
Normal file
|
After Width: | Height: | Size: 116 KiB |
BIN
docs/picasa/1.0.7/fonts/OpenSans-Bold-webfont.woff
Normal file
BIN
docs/picasa/1.0.7/fonts/OpenSans-BoldItalic-webfont.eot
Normal file
1830
docs/picasa/1.0.7/fonts/OpenSans-BoldItalic-webfont.svg
Normal file
|
After Width: | Height: | Size: 118 KiB |
BIN
docs/picasa/1.0.7/fonts/OpenSans-BoldItalic-webfont.woff
Normal file
BIN
docs/picasa/1.0.7/fonts/OpenSans-Italic-webfont.eot
Normal file
1830
docs/picasa/1.0.7/fonts/OpenSans-Italic-webfont.svg
Normal file
|
After Width: | Height: | Size: 120 KiB |
BIN
docs/picasa/1.0.7/fonts/OpenSans-Italic-webfont.woff
Normal file
BIN
docs/picasa/1.0.7/fonts/OpenSans-Light-webfont.eot
Normal file
1831
docs/picasa/1.0.7/fonts/OpenSans-Light-webfont.svg
Normal file
|
After Width: | Height: | Size: 114 KiB |
BIN
docs/picasa/1.0.7/fonts/OpenSans-Light-webfont.woff
Normal file
BIN
docs/picasa/1.0.7/fonts/OpenSans-LightItalic-webfont.eot
Normal file
1835
docs/picasa/1.0.7/fonts/OpenSans-LightItalic-webfont.svg
Normal file
|
After Width: | Height: | Size: 120 KiB |
BIN
docs/picasa/1.0.7/fonts/OpenSans-LightItalic-webfont.woff
Normal file
BIN
docs/picasa/1.0.7/fonts/OpenSans-Regular-webfont.eot
Normal file
1831
docs/picasa/1.0.7/fonts/OpenSans-Regular-webfont.svg
Normal file
|
After Width: | Height: | Size: 117 KiB |
BIN
docs/picasa/1.0.7/fonts/OpenSans-Regular-webfont.woff
Normal file
BIN
docs/picasa/1.0.7/fonts/OpenSans-Semibold-webfont.eot
Normal file
1830
docs/picasa/1.0.7/fonts/OpenSans-Semibold-webfont.svg
Normal file
|
After Width: | Height: | Size: 116 KiB |
BIN
docs/picasa/1.0.7/fonts/OpenSans-Semibold-webfont.ttf
Normal file
BIN
docs/picasa/1.0.7/fonts/OpenSans-Semibold-webfont.woff
Normal file
BIN
docs/picasa/1.0.7/fonts/OpenSans-SemiboldItalic-webfont.eot
Normal file
1830
docs/picasa/1.0.7/fonts/OpenSans-SemiboldItalic-webfont.svg
Normal file
|
After Width: | Height: | Size: 120 KiB |
BIN
docs/picasa/1.0.7/fonts/OpenSans-SemiboldItalic-webfont.ttf
Normal file
BIN
docs/picasa/1.0.7/fonts/OpenSans-SemiboldItalic-webfont.woff
Normal file
453
docs/picasa/1.0.7/global.html
Normal file
@@ -0,0 +1,453 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<title>Global - Documentation</title>
|
||||
|
||||
<script src="scripts/prettify/prettify.js"></script>
|
||||
<script src="scripts/prettify/lang-css.js"></script>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
||||
<![endif]-->
|
||||
<link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
|
||||
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
||||
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
|
||||
<label for="nav-trigger" class="navicon-button x">
|
||||
<div class="navicon"></div>
|
||||
</label>
|
||||
|
||||
<label for="nav-trigger" class="overlay"></label>
|
||||
|
||||
<nav>
|
||||
<li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading">Classes</li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Picasa.html">Picasa</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#createAlbum">createAlbum</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#deletePhoto">deletePhoto</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#getAlbums">getAlbums</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#getAuthURL">getAuthURL</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#getPhotos">getPhotos</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#getTokens">getTokens</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#postPhoto">postPhoto</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#renewAccessToken">renewAccessToken</a></span></li><li class="nav-heading"><a href="global.html">Globals</a></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#getAccessToken">getAccessToken</a></span></li>
|
||||
</nav>
|
||||
|
||||
<div id="main">
|
||||
|
||||
<h1 class="page-title">Global</h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section>
|
||||
|
||||
<header>
|
||||
|
||||
<h2>
|
||||
|
||||
</h2>
|
||||
|
||||
|
||||
</header>
|
||||
|
||||
<article>
|
||||
<div class="container-overview">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="details">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h3 class="subsection-title">Methods</h3>
|
||||
|
||||
|
||||
|
||||
<div class="section-method">
|
||||
|
||||
|
||||
|
||||
<h4 class="name" id="getAccessToken"><span class="type-signature"></span>getAccessToken<span class="signature">(config, code, callback)</span><span class="type-signature"> → {Promise}</span></h4>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="description">
|
||||
Get access token. To be deprecated soon. Use <a href="Picasa.html#getTokens"><code>Picasa#getTokens</code></a> instead
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dl class="details">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="picasa.js.html">picasa.js</a>, <a href="picasa.js.html#line362">line 362</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</dl>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<h5>Parameters:</h5>
|
||||
|
||||
|
||||
<table class="params">
|
||||
<thead>
|
||||
<tr>
|
||||
|
||||
<th>Name</th>
|
||||
|
||||
|
||||
<th>Type</th>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<th class="last">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
|
||||
<tbody>
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>config</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type"><code>object</code></span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last">
|
||||
Get config here: <a href="https://console.developers.google.com/home/dashboard">https://console.developers.google.com/home/dashboard</a> (API Manager > Credentials)
|
||||
|
||||
|
||||
|
||||
<table class="params">
|
||||
<thead>
|
||||
<tr>
|
||||
|
||||
<th>Name</th>
|
||||
|
||||
|
||||
<th>Type</th>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<th class="last">Description</th>
|
||||
</tr>
|
||||
</thead>
|
||||
|
||||
<tbody>
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>clientId</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type"><code>string</code></span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last">
|
||||
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>redirectURI</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type"><code>string</code></span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last">
|
||||
URL that user was redirected. After google displays a consent screen to the user, user will be redirect to this URL with a `code` in the URL
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>clientSecret</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type"><code>string</code></span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last">
|
||||
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>code</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type"><code>string</code></span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last">
|
||||
Get code from URL param, when user is redirected from authURL. See <a href="Picasa.html#getAuthURL"><code>Picasa#getAuthURL</code></a>
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
|
||||
|
||||
<tr>
|
||||
|
||||
<td class="name"><code>callback</code></td>
|
||||
|
||||
|
||||
<td class="type">
|
||||
|
||||
|
||||
<span class="param-type"><code>function</code></span>
|
||||
|
||||
|
||||
|
||||
</td>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<td class="description last">
|
||||
(error, response{accessToken, refreshToken}). If not provided, a promise will be returned
|
||||
|
||||
</td>
|
||||
</tr>
|
||||
|
||||
|
||||
</tbody>
|
||||
</table>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<div class="section-returns">
|
||||
<h5>Returns:</h5>
|
||||
|
||||
|
||||
|
||||
<dl class="param-type">
|
||||
<dt>
|
||||
Type:
|
||||
</dt>
|
||||
<dd>
|
||||
|
||||
<span class="param-type"><code>Promise</code></span>
|
||||
|
||||
|
||||
</dd>
|
||||
</dl>
|
||||
|
||||
|
||||
<div class="param-desc">
|
||||
- String accessToken
|
||||
</div>
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</article>
|
||||
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<br class="clear">
|
||||
|
||||
<footer>
|
||||
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Mar 04 2018 20:34:29 GMT+0100 (CET) using the Minami theme.
|
||||
</footer>
|
||||
|
||||
<script>prettyPrint();</script>
|
||||
<script src="scripts/linenumber.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
113
docs/picasa/1.0.7/index.html
Normal file
@@ -0,0 +1,113 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<title>Home - Documentation</title>
|
||||
|
||||
<script src="scripts/prettify/prettify.js"></script>
|
||||
<script src="scripts/prettify/lang-css.js"></script>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
||||
<![endif]-->
|
||||
<link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
|
||||
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
||||
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
|
||||
<label for="nav-trigger" class="navicon-button x">
|
||||
<div class="navicon"></div>
|
||||
</label>
|
||||
|
||||
<label for="nav-trigger" class="overlay"></label>
|
||||
|
||||
<nav>
|
||||
<li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading">Classes</li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Picasa.html">Picasa</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#createAlbum">createAlbum</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#deletePhoto">deletePhoto</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#getAlbums">getAlbums</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#getAuthURL">getAuthURL</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#getPhotos">getPhotos</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#getTokens">getTokens</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#postPhoto">postPhoto</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#renewAccessToken">renewAccessToken</a></span></li><li class="nav-heading"><a href="global.html">Globals</a></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#getAccessToken">getAccessToken</a></span></li>
|
||||
</nav>
|
||||
|
||||
<div id="main">
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section class="readme">
|
||||
<article><p><a href="https://travis-ci.org/esteban-uo/picasa"><img src="https://travis-ci.org/esteban-uo/picasa.svg" alt="Build Status"></a></p>
|
||||
<p>A simple <strong>Google Photos</strong>, formally <strong>Picasa</strong> Web Albums client (2.0) for nodejs (>= 4.8.7). Includes Auth helpers.</p>
|
||||
<p><img src="https://www.wptribe.net/wp-content/uploads/2013/01/Picasa_Logo.jpg" /></p>
|
||||
<h3>Install</h3><pre class="prettyprint source"><code>$ yarn add picasa</code></pre><p>or</p>
|
||||
<pre class="prettyprint source"><code>$ npm install --save picasa</code></pre><h3>Usage</h3><pre class="prettyprint source lang-js"><code>const Picasa = require('picasa')
|
||||
|
||||
const picasa = new Picasa()</code></pre><h3>Docs</h3><p>API for Photos, Albums and Auth can be found <a href="./docs">here</a>. Please check out also the examples dir for more detailed examples. Rename <code>config.example.json</code> to <code>config.json</code> and add your own config data.</p>
|
||||
<h3>Auth</h3><p>To get an access token follow the next flow:</p>
|
||||
<p>1.Get the Auth URL and redirect the user to it.</p>
|
||||
<pre class="prettyprint source lang-js"><code>// Get config here API Manager > Credentials https://console.developers.google.com/home/dashboard
|
||||
const config = {
|
||||
clientId : 'yourClientId',
|
||||
redirectURI : 'redirectURI'
|
||||
}
|
||||
|
||||
const authURL = picasa.getAuthURL(config)</code></pre><p>2.Google displays a consent screen to the user, asking them to authorize your application to request some of their data.</p>
|
||||
<p>3.Google redirects a code to your redirectURI.</p>
|
||||
<p>4.Use the code given as GET param in order to get an access token:</p>
|
||||
<pre class="prettyprint source lang-js"><code>// Get config here API Manager > Credentials https://console.developers.google.com/home/dashboard
|
||||
const config = {
|
||||
clientId : 'yourClientId',
|
||||
redirectURI : 'redirectURI'
|
||||
clientSecret : 'yourClientSecret'
|
||||
}
|
||||
|
||||
picasa.getTokens(config, code).then(tokens => {
|
||||
/* use tokens.accessToken or tokens.refreshToken */
|
||||
})</code></pre><p>5.If you need to renew an expired <code>accessToken</code>, use the <code>refreshToken</code> with <code>picasa.renewAccessToken</code>:</p>
|
||||
<pre class="prettyprint source lang-js"><code>const config = {
|
||||
clientId : 'yourClientId',
|
||||
redirectURI : 'redirectURI'
|
||||
clientSecret : 'yourClientSecret'
|
||||
}
|
||||
|
||||
picasa.renewAccessToken(config, refreshToken).then(renewedAccessToken => {
|
||||
/* do something with renewedAccessToken */
|
||||
})</code></pre><h2>Change Log</h2><p><strong><em>1.0.7</em></strong> Functions return a Promise if callback is not provided. Use <code>getTokens</code> if you want to use Promises instead <code>getAccessToken</code>.</p>
|
||||
<p><strong><em>1.0.6</em></strong> Get album, Create Album, Renew access token added. Get Photos can get all photos from an album id or all.</p>
|
||||
<h2>Contributors</h2><p>Thanks to
|
||||
<a href="https://github.com/z1c0">z1c0</a>, <a href="https://github.com/hbakhtiyor">hbakhtiyor</a>, <a href="https://github.com/pauarge">pauarge</a>, <a href="https://github.com/wreuven">wreuven</a></p>
|
||||
<h2>License</h2><p>MIT ©</p>
|
||||
<hr>
|
||||
<p>Play around https://developers.google.com/oauthplayground/?code=4/usq8QmuezR3Au_0UKyj9-UXmf6Bw_ij8KFWgIziYbpM#</p>
|
||||
<p>Picasa Docs https://developers.google.com/picasa-web/docs/2.0/developers_guide_protocol</p></article>
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<br class="clear">
|
||||
|
||||
<footer>
|
||||
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Mar 04 2018 20:34:29 GMT+0100 (CET) using the Minami theme.
|
||||
</footer>
|
||||
|
||||
<script>prettyPrint();</script>
|
||||
<script src="scripts/linenumber.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
487
docs/picasa/1.0.7/picasa.js.html
Normal file
@@ -0,0 +1,487 @@
|
||||
<!DOCTYPE html>
|
||||
<html lang="en">
|
||||
<head>
|
||||
<meta charset="utf-8">
|
||||
<meta name="viewport" content="width=device-width,initial-scale=1">
|
||||
<title>picasa.js - Documentation</title>
|
||||
|
||||
<script src="scripts/prettify/prettify.js"></script>
|
||||
<script src="scripts/prettify/lang-css.js"></script>
|
||||
<!--[if lt IE 9]>
|
||||
<script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
|
||||
<![endif]-->
|
||||
<link type="text/css" rel="stylesheet" href="https://code.ionicframework.com/ionicons/2.0.1/css/ionicons.min.css">
|
||||
<link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
|
||||
<link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
|
||||
</head>
|
||||
<body>
|
||||
|
||||
<input type="checkbox" id="nav-trigger" class="nav-trigger" />
|
||||
<label for="nav-trigger" class="navicon-button x">
|
||||
<div class="navicon"></div>
|
||||
</label>
|
||||
|
||||
<label for="nav-trigger" class="overlay"></label>
|
||||
|
||||
<nav>
|
||||
<li class="nav-link nav-home-link"><a href="index.html">Home</a></li><li class="nav-heading">Classes</li><li class="nav-heading"><span class="nav-item-type type-class">C</span><span class="nav-item-name"><a href="Picasa.html">Picasa</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#createAlbum">createAlbum</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#deletePhoto">deletePhoto</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#getAlbums">getAlbums</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#getAuthURL">getAuthURL</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#getPhotos">getPhotos</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#getTokens">getTokens</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#postPhoto">postPhoto</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="Picasa.html#renewAccessToken">renewAccessToken</a></span></li><li class="nav-heading"><a href="global.html">Globals</a></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="global.html#getAccessToken">getAccessToken</a></span></li>
|
||||
</nav>
|
||||
|
||||
<div id="main">
|
||||
|
||||
<h1 class="page-title">picasa.js</h1>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
<section>
|
||||
<article>
|
||||
<pre class="prettyprint source linenums"><code>'use strict'
|
||||
|
||||
const querystring = require('querystring')
|
||||
|
||||
const promisify = require('./promisify')
|
||||
const executeRequest = require('./executeRequest')
|
||||
|
||||
const GOOGLE_AUTH_ENDPOINT = 'https://accounts.google.com/o/oauth2/auth'
|
||||
const GOOGLE_API_HOST = 'https://www.googleapis.com'
|
||||
const GOOGLE_API_PATH = '/oauth2/v3/token'
|
||||
const GOOGLE_API_PATH_NEW = '/oauth2/v4/token'
|
||||
|
||||
const PICASA_SCOPE = 'https://picasaweb.google.com/data'
|
||||
const PICASA_API_FEED_PATH = '/feed/api/user/default'
|
||||
const PICASA_API_ENTRY_PATH = '/entry/api/user/default'
|
||||
|
||||
const FETCH_AS_JSON = 'json'
|
||||
|
||||
/** Main class */
|
||||
class Picasa {
|
||||
/**
|
||||
* Creates an instance of Picasa.
|
||||
*/
|
||||
constructor() {
|
||||
this.executeRequest = executeRequest
|
||||
this.getAccessToken = getAccessToken.bind(this)
|
||||
}
|
||||
|
||||
/**
|
||||
* Get Photos
|
||||
* @param {string} accessToken - See {@link Picasa#getTokens}
|
||||
* @param {object} options - Can be empty object
|
||||
* @param {integer} options.maxResults - By default get all photos
|
||||
* @param {string} options.albumId - By default all photos are selected
|
||||
* @param {function} callback - (error, response). If not provided, a promise will be returned
|
||||
* @returns {Promise}
|
||||
*/
|
||||
getPhotos() {
|
||||
return promisify.bind(this)(getPhotos, arguments)
|
||||
}
|
||||
|
||||
/**
|
||||
* Create Photos
|
||||
* @param {string} accessToken - See {@link Picasa#getTokens}
|
||||
* @param {string} albumId
|
||||
* @param {object} photoData - Photo's propperties
|
||||
* @param {string} photoData.title
|
||||
* @param {string} photoData.summary
|
||||
* @param {string} photoData.contentType - image/bmp, image/gif, image/png
|
||||
* @param {blob} photoData.binary - Blob binary
|
||||
* @param {function} callback - (error, response). If not provided, a promise will be returned
|
||||
* @returns {Promise}
|
||||
*/
|
||||
postPhoto() {
|
||||
return promisify.bind(this)(postPhoto, arguments)
|
||||
}
|
||||
|
||||
/**
|
||||
* Delete Photo
|
||||
* @param {string} accessToken - See {@link Picasa#getTokens}
|
||||
* @param {string} albumId
|
||||
* @param {string} photoId
|
||||
* @param {function} callback - (error, response). If not provided, a promise will be returned
|
||||
* @returns {Promise}
|
||||
*/
|
||||
deletePhoto() {
|
||||
return promisify.bind(this)(deletePhoto, arguments)
|
||||
}
|
||||
|
||||
/**
|
||||
* Get all Albums
|
||||
* @param {string} accessToken - See {@link Picasa#getTokens}
|
||||
* @param {object} options - Can be empty object
|
||||
* @param {integer} options.TODO - TODO
|
||||
* @param {function} callback - (error, response). If not provided, a promise will be returned
|
||||
* @returns {Promise}
|
||||
*/
|
||||
getAlbums() {
|
||||
return promisify.bind(this)(getAlbums, arguments)
|
||||
}
|
||||
|
||||
/**
|
||||
* Create an albums
|
||||
* @param {string} accessToken - See {@link Picasa#getTokens}
|
||||
* @param {object} albumData - Can be empty object
|
||||
* @param {string} albumData.title
|
||||
* @param {string} albumData.summary
|
||||
* @param {function} callback - (error, response). If not provided, a promise will be returned
|
||||
* @returns {Promise}
|
||||
*/
|
||||
createAlbum() {
|
||||
return promisify.bind(this)(createAlbum, arguments)
|
||||
}
|
||||
|
||||
/**
|
||||
* Get access token and refresh token
|
||||
* @param {object} config - Get config here: {@link https://console.developers.google.com/home/dashboard} (API Manager > Credentials)
|
||||
* @param {string} config.clientId
|
||||
* @param {string} config.redirectURI - URL that user was redirected. After google displays a consent screen to the user, user will be redirect to this URL with a `code` in the URL
|
||||
* @param {string} config.clientSecret
|
||||
* @param {string} code - Get code from URL param, when user is redirected from authURL. See {@link Picasa#getAuthURL}
|
||||
* @param {function} callback - (error, response{accessToken, refreshToken}). If not provided, a promise will be returned
|
||||
* @returns {Promise} - Object{accessToken, refreshToken}
|
||||
*/
|
||||
getTokens() {
|
||||
return promisify.bind(this)(getTokens, arguments)
|
||||
}
|
||||
|
||||
/**
|
||||
* Renews access token
|
||||
* @param {object} config - Get config here: {@link https://console.developers.google.com/home/dashboard} (API Manager > Credentials)
|
||||
* @param {string} config.clientId
|
||||
* @param {string} config.redirectURI - URL that user was redirected. After google displays a consent screen to the user, user will be redirect to this URL with a `code` in the URL
|
||||
* @param {string} config.clientSecret
|
||||
* @param {string} refreshToken - The refreshToken is retrived after getTokens is executed. See {@link Picasa#getTokens}
|
||||
* @param {function} callback - (error, response). If not provided, a promise will be returned
|
||||
* @returns {Promise}
|
||||
*/
|
||||
renewAccessToken() {
|
||||
return promisify.bind(this)(renewAccessToken, arguments)
|
||||
}
|
||||
|
||||
/**
|
||||
* Get Auth URL. Redirect user to this URL to get code. The code will be used later for {@link Picasa#getTokens}
|
||||
* @param {object} config - Get config here: https://console.developers.google.com/home/dashboard (API Manager > Credentials)
|
||||
* @param {string} config.clientId
|
||||
* @param {string} config.redirectURI - URL to user will be redirected. After google displays a consent screen to the user, user will be redirect to this URL with a `code` in the URL
|
||||
* @param {function} callback - (error, response). If not provided, a promise will be returned
|
||||
* @returns {Promise}
|
||||
*/
|
||||
getAuthURL(config) {
|
||||
const authenticationParams = {
|
||||
access_type: 'offline',
|
||||
scope: `${PICASA_SCOPE}`,
|
||||
response_type: 'code',
|
||||
client_id: config.clientId,
|
||||
redirect_uri: config.redirectURI
|
||||
}
|
||||
|
||||
const authenticationQuery = querystring.stringify(authenticationParams)
|
||||
|
||||
return `${GOOGLE_AUTH_ENDPOINT}?${authenticationQuery}`
|
||||
}
|
||||
}
|
||||
|
||||
function getAlbums(accessToken, options, callback) {
|
||||
const accessTokenParams = {
|
||||
alt: FETCH_AS_JSON,
|
||||
access_token: accessToken
|
||||
}
|
||||
|
||||
options = options || {}
|
||||
|
||||
const requestQuery = querystring.stringify(accessTokenParams)
|
||||
|
||||
const requestOptions = {
|
||||
url: `${PICASA_SCOPE}${PICASA_API_FEED_PATH}?${requestQuery}`,
|
||||
headers: {
|
||||
'GData-Version': '2'
|
||||
}
|
||||
}
|
||||
|
||||
this.executeRequest('get', requestOptions, (error, body) => {
|
||||
if (error) return callback(error)
|
||||
|
||||
const albums = body.feed.entry.map(
|
||||
entry => parseEntry(entry, albumSchema)
|
||||
)
|
||||
callback(null, albums)
|
||||
})
|
||||
}
|
||||
|
||||
function deletePhoto(accessToken, albumId, photoId, callback) {
|
||||
const requestQuery = querystring.stringify({
|
||||
alt: FETCH_AS_JSON,
|
||||
access_token: accessToken
|
||||
})
|
||||
|
||||
const requestOptions = {
|
||||
url: `${PICASA_SCOPE}${PICASA_API_ENTRY_PATH}/albumid/${albumId}/photoid/${photoId}?${requestQuery}`,
|
||||
headers: {
|
||||
'If-Match': '*'
|
||||
}
|
||||
}
|
||||
|
||||
this.executeRequest('del', requestOptions, callback)
|
||||
}
|
||||
|
||||
function createAlbum(accessToken, albumData, callback) {
|
||||
const requestQuery = querystring.stringify({
|
||||
alt: FETCH_AS_JSON,
|
||||
access_token: accessToken
|
||||
})
|
||||
|
||||
const albumInfoAtom = `<entry xmlns='http://www.w3.org/2005/Atom'
|
||||
xmlns:media='http://search.yahoo.com/mrss/'
|
||||
xmlns:gphoto='http://schemas.google.com/photos/2007'>
|
||||
<title type='text'>${albumData.title}</title>
|
||||
<summary type='text'>${albumData.summary}</summary>
|
||||
<gphoto:access>private</gphoto:access>
|
||||
<category scheme='http://schemas.google.com/g/2005#kind'
|
||||
term='http://schemas.google.com/photos/2007#album'></category>
|
||||
</entry>`
|
||||
|
||||
const requestOptions = {
|
||||
url: `${PICASA_SCOPE}${PICASA_API_FEED_PATH}?${requestQuery}`,
|
||||
body: albumInfoAtom,
|
||||
headers: { 'Content-Type': 'application/atom+xml' }
|
||||
}
|
||||
|
||||
this.executeRequest('post', requestOptions, (error, body) => {
|
||||
if (error) return callback(error)
|
||||
|
||||
const album = parseEntry(body.entry, albumSchema)
|
||||
|
||||
callback(error, album)
|
||||
})
|
||||
}
|
||||
|
||||
function postPhoto(accessToken, albumId, photoData, callback) {
|
||||
const requestQuery = querystring.stringify({
|
||||
alt: FETCH_AS_JSON,
|
||||
access_token: accessToken
|
||||
})
|
||||
|
||||
const photoInfoAtom = `<entry xmlns="http://www.w3.org/2005/Atom">
|
||||
<title>${photoData.title}</title>
|
||||
<summary>${photoData.summary}</summary>
|
||||
<category scheme="http://schemas.google.com/g/2005#kind" term="http://schemas.google.com/photos/2007#photo"/>
|
||||
</entry>`
|
||||
|
||||
const requestOptions = {
|
||||
url: `${PICASA_SCOPE}${PICASA_API_FEED_PATH}/albumid/${albumId}?${requestQuery}`,
|
||||
multipart: [
|
||||
{ 'Content-Type': 'application/atom+xml', body: photoInfoAtom },
|
||||
{ 'Content-Type': photoData.contentType, body: photoData.binary }
|
||||
]
|
||||
}
|
||||
|
||||
this.executeRequest('post', requestOptions, (error, body) => {
|
||||
if (error) return callback(error)
|
||||
|
||||
const photo = parseEntry(body.entry, photoSchema)
|
||||
|
||||
callback(error, photo)
|
||||
})
|
||||
}
|
||||
|
||||
function getPhotos(accessToken, options, callback) {
|
||||
const accessTokenParams = {
|
||||
alt: FETCH_AS_JSON,
|
||||
kind: 'photo',
|
||||
access_token: accessToken
|
||||
}
|
||||
|
||||
options = options || {}
|
||||
|
||||
if (options.maxResults) accessTokenParams['max-results'] = options.maxResults
|
||||
if (options.startIndex) accessTokenParams['start-index'] = options.startIndex
|
||||
if (options.imgMax) accessTokenParams['imgmax'] = options.imgMax
|
||||
|
||||
const albumPart = options.albumId ? `/albumid/${options.albumId}` : ''
|
||||
|
||||
const requestQuery = querystring.stringify(accessTokenParams)
|
||||
|
||||
const requestOptions = {
|
||||
url: `${PICASA_SCOPE}${PICASA_API_FEED_PATH}${albumPart}?${requestQuery}`,
|
||||
headers: {
|
||||
'GData-Version': '2'
|
||||
}
|
||||
}
|
||||
|
||||
this.executeRequest('get', requestOptions, (error, body) => {
|
||||
if (error) return callback(error)
|
||||
|
||||
const photos = body.feed.entry.map(
|
||||
entry => parseEntry(entry, photoSchema)
|
||||
)
|
||||
|
||||
callback(null, photos)
|
||||
})
|
||||
}
|
||||
|
||||
const albumSchema = {
|
||||
'media$group.media$thumbnail': 'thumbnail',
|
||||
'gphoto$id': 'id',
|
||||
'gphoto$name': 'name',
|
||||
'gphoto$numphotos': 'num_photos',
|
||||
'published': 'published',
|
||||
'title': 'title',
|
||||
'summary': 'summary',
|
||||
'gphoto$location': 'location',
|
||||
'gphoto$nickname': 'nickname',
|
||||
'rights': 'rights',
|
||||
'gphoto$access': 'access'
|
||||
}
|
||||
|
||||
const photoSchema = {
|
||||
'gphoto$id': 'id',
|
||||
'gphoto$albumid': 'album_id',
|
||||
'gphoto$access': 'access',
|
||||
'gphoto$width': 'width',
|
||||
'gphoto$height': 'height',
|
||||
'gphoto$size': 'size',
|
||||
'gphoto$checksum': 'checksum',
|
||||
'gphoto$timestamp': 'timestamp',
|
||||
'gphoto$imageVersion': 'image_version',
|
||||
'gphoto$commentingEnabled': 'commenting_enabled',
|
||||
'gphoto$commentCount': 'comment_count',
|
||||
'content': 'content',
|
||||
'title': 'title',
|
||||
'summary': 'summary'
|
||||
}
|
||||
|
||||
function parseEntry(entry, schema) {
|
||||
let photo = {}
|
||||
|
||||
Object.keys(schema).forEach(schemaKey => {
|
||||
const key = schema[schemaKey]
|
||||
|
||||
if (key) {
|
||||
const value = extractValue(entry, schemaKey, key)
|
||||
photo[key] = value
|
||||
}
|
||||
})
|
||||
|
||||
return photo
|
||||
}
|
||||
|
||||
function extractValue(entry, schemaKey) {
|
||||
if (schemaKey.indexOf('.') !== -1) {
|
||||
const tempKey = schemaKey.split('.')[0]
|
||||
return extractValue(checkParam(entry[tempKey]), schemaKey.replace(`${tempKey}.`, ''))
|
||||
}
|
||||
return checkParam(entry[schemaKey])
|
||||
}
|
||||
|
||||
function getAuthURL(config) {
|
||||
const authenticationParams = {
|
||||
access_type: 'offline',
|
||||
scope: `${PICASA_SCOPE}`,
|
||||
response_type: 'code',
|
||||
client_id: config.clientId,
|
||||
redirect_uri: config.redirectURI
|
||||
}
|
||||
|
||||
const authenticationQuery = querystring.stringify(authenticationParams)
|
||||
|
||||
return `${GOOGLE_AUTH_ENDPOINT}?${authenticationQuery}`
|
||||
}
|
||||
|
||||
/**
|
||||
* Get access token. To be deprecated soon. Use {@link Picasa#getTokens} instead
|
||||
* @param {object} config - Get config here: {@link https://console.developers.google.com/home/dashboard} (API Manager > Credentials)
|
||||
* @param {string} config.clientId
|
||||
* @param {string} config.redirectURI - URL that user was redirected. After google displays a consent screen to the user, user will be redirect to this URL with a `code` in the URL
|
||||
* @param {string} config.clientSecret
|
||||
* @param {string} code - Get code from URL param, when user is redirected from authURL. See {@link Picasa#getAuthURL}
|
||||
* @param {function} callback - (error, response{accessToken, refreshToken}). If not provided, a promise will be returned
|
||||
* @returns {Promise} - String accessToken
|
||||
*/
|
||||
function getAccessToken(config, code, callback) {
|
||||
const accessTokenParams = {
|
||||
grant_type: 'authorization_code',
|
||||
code: code,
|
||||
redirect_uri: config.redirectURI,
|
||||
client_id: config.clientId,
|
||||
client_secret: config.clientSecret
|
||||
}
|
||||
|
||||
const requestQuery = querystring.stringify(accessTokenParams)
|
||||
const options = {
|
||||
url: `${GOOGLE_API_HOST}${GOOGLE_API_PATH}?${requestQuery}`
|
||||
}
|
||||
|
||||
this.executeRequest('post', options, (error, body) => {
|
||||
if (error) return callback(error)
|
||||
|
||||
callback(null, body.access_token, body.refresh_token)
|
||||
})
|
||||
}
|
||||
|
||||
function getTokens(config, code, callback) {
|
||||
return getAccessToken(config, code, (error, accessToken, refreshToken) => {
|
||||
if (error) return callback(error)
|
||||
|
||||
const tokens = {
|
||||
accessToken,
|
||||
refreshToken,
|
||||
}
|
||||
|
||||
callback(null, tokens)
|
||||
})
|
||||
}
|
||||
|
||||
function renewAccessToken(config, refresh_token, callback) {
|
||||
const refreshTokenParams = {
|
||||
grant_type: 'refresh_token',
|
||||
client_id: config.clientId,
|
||||
client_secret: config.clientSecret,
|
||||
refresh_token: refresh_token
|
||||
}
|
||||
|
||||
const requestQuery = querystring.stringify(refreshTokenParams)
|
||||
const options = {
|
||||
url: `${GOOGLE_API_HOST}${GOOGLE_API_PATH_NEW}?${requestQuery}`
|
||||
}
|
||||
|
||||
this.executeRequest('post', options, (error, body) => {
|
||||
if (error) return callback(error)
|
||||
|
||||
callback(null, body.access_token)
|
||||
})
|
||||
}
|
||||
|
||||
function checkParam(param) {
|
||||
if (param === undefined) return ''
|
||||
else if (isValidType(param)) return param
|
||||
else if (isValidType(param['$t'])) return param['$t']
|
||||
else return param
|
||||
}
|
||||
|
||||
function isValidType(value) {
|
||||
return typeof value === 'string' || typeof value === 'number'
|
||||
}
|
||||
|
||||
module.exports = Picasa
|
||||
</code></pre>
|
||||
</article>
|
||||
</section>
|
||||
|
||||
|
||||
|
||||
|
||||
</div>
|
||||
|
||||
<br class="clear">
|
||||
|
||||
<footer>
|
||||
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Mar 04 2018 20:34:29 GMT+0100 (CET) using the Minami theme.
|
||||
</footer>
|
||||
|
||||
<script>prettyPrint();</script>
|
||||
<script src="scripts/linenumber.js"></script>
|
||||
</body>
|
||||
</html>
|
||||
25
docs/picasa/1.0.7/scripts/linenumber.js
Normal file
@@ -0,0 +1,25 @@
|
||||
/*global document */
|
||||
(function() {
|
||||
var source = document.getElementsByClassName('prettyprint source linenums');
|
||||
var i = 0;
|
||||
var lineNumber = 0;
|
||||
var lineId;
|
||||
var lines;
|
||||
var totalLines;
|
||||
var anchorHash;
|
||||
|
||||
if (source && source[0]) {
|
||||
anchorHash = document.location.hash.substring(1);
|
||||
lines = source[0].getElementsByTagName('li');
|
||||
totalLines = lines.length;
|
||||
|
||||
for (; i < totalLines; i++) {
|
||||
lineNumber++;
|
||||
lineId = 'line' + lineNumber;
|
||||
lines[i].id = lineId;
|
||||
if (lineId === anchorHash) {
|
||||
lines[i].className += ' selected';
|
||||
}
|
||||
}
|
||||
}
|
||||
})();
|
||||
202
docs/picasa/1.0.7/scripts/prettify/Apache-License-2.0.txt
Normal file
@@ -0,0 +1,202 @@
|
||||
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
2
docs/picasa/1.0.7/scripts/prettify/lang-css.js
Normal file
@@ -0,0 +1,2 @@
|
||||
PR.registerLangHandler(PR.createSimpleLexer([["pln",/^[\t\n\f\r ]+/,null," \t\r\n"]],[["str",/^"(?:[^\n\f\r"\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*"/,null],["str",/^'(?:[^\n\f\r'\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*'/,null],["lang-css-str",/^url\(([^"')]*)\)/i],["kwd",/^(?:url|rgb|!important|@import|@page|@media|@charset|inherit)(?=[^\w-]|$)/i,null],["lang-css-kw",/^(-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*)\s*:/i],["com",/^\/\*[^*]*\*+(?:[^*/][^*]*\*+)*\//],["com",
|
||||
/^(?:<\!--|--\>)/],["lit",/^(?:\d+|\d*\.\d+)(?:%|[a-z]+)?/i],["lit",/^#[\da-f]{3,6}/i],["pln",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i],["pun",/^[^\s\w"']+/]]),["css"]);PR.registerLangHandler(PR.createSimpleLexer([],[["kwd",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i]]),["css-kw"]);PR.registerLangHandler(PR.createSimpleLexer([],[["str",/^[^"')]+/]]),["css-str"]);
|
||||
28
docs/picasa/1.0.7/scripts/prettify/prettify.js
Normal file
@@ -0,0 +1,28 @@
|
||||
var q=null;window.PR_SHOULD_USE_CONTINUATION=!0;
|
||||
(function(){function L(a){function m(a){var f=a.charCodeAt(0);if(f!==92)return f;var b=a.charAt(1);return(f=r[b])?f:"0"<=b&&b<="7"?parseInt(a.substring(1),8):b==="u"||b==="x"?parseInt(a.substring(2),16):a.charCodeAt(1)}function e(a){if(a<32)return(a<16?"\\x0":"\\x")+a.toString(16);a=String.fromCharCode(a);if(a==="\\"||a==="-"||a==="["||a==="]")a="\\"+a;return a}function h(a){for(var f=a.substring(1,a.length-1).match(/\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\[0-3][0-7]{0,2}|\\[0-7]{1,2}|\\[\S\s]|[^\\]/g),a=
|
||||
[],b=[],o=f[0]==="^",c=o?1:0,i=f.length;c<i;++c){var j=f[c];if(/\\[bdsw]/i.test(j))a.push(j);else{var j=m(j),d;c+2<i&&"-"===f[c+1]?(d=m(f[c+2]),c+=2):d=j;b.push([j,d]);d<65||j>122||(d<65||j>90||b.push([Math.max(65,j)|32,Math.min(d,90)|32]),d<97||j>122||b.push([Math.max(97,j)&-33,Math.min(d,122)&-33]))}}b.sort(function(a,f){return a[0]-f[0]||f[1]-a[1]});f=[];j=[NaN,NaN];for(c=0;c<b.length;++c)i=b[c],i[0]<=j[1]+1?j[1]=Math.max(j[1],i[1]):f.push(j=i);b=["["];o&&b.push("^");b.push.apply(b,a);for(c=0;c<
|
||||
f.length;++c)i=f[c],b.push(e(i[0])),i[1]>i[0]&&(i[1]+1>i[0]&&b.push("-"),b.push(e(i[1])));b.push("]");return b.join("")}function y(a){for(var f=a.source.match(/\[(?:[^\\\]]|\\[\S\s])*]|\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\\d+|\\[^\dux]|\(\?[!:=]|[()^]|[^()[\\^]+/g),b=f.length,d=[],c=0,i=0;c<b;++c){var j=f[c];j==="("?++i:"\\"===j.charAt(0)&&(j=+j.substring(1))&&j<=i&&(d[j]=-1)}for(c=1;c<d.length;++c)-1===d[c]&&(d[c]=++t);for(i=c=0;c<b;++c)j=f[c],j==="("?(++i,d[i]===void 0&&(f[c]="(?:")):"\\"===j.charAt(0)&&
|
||||
(j=+j.substring(1))&&j<=i&&(f[c]="\\"+d[i]);for(i=c=0;c<b;++c)"^"===f[c]&&"^"!==f[c+1]&&(f[c]="");if(a.ignoreCase&&s)for(c=0;c<b;++c)j=f[c],a=j.charAt(0),j.length>=2&&a==="["?f[c]=h(j):a!=="\\"&&(f[c]=j.replace(/[A-Za-z]/g,function(a){a=a.charCodeAt(0);return"["+String.fromCharCode(a&-33,a|32)+"]"}));return f.join("")}for(var t=0,s=!1,l=!1,p=0,d=a.length;p<d;++p){var g=a[p];if(g.ignoreCase)l=!0;else if(/[a-z]/i.test(g.source.replace(/\\u[\da-f]{4}|\\x[\da-f]{2}|\\[^UXux]/gi,""))){s=!0;l=!1;break}}for(var r=
|
||||
{b:8,t:9,n:10,v:11,f:12,r:13},n=[],p=0,d=a.length;p<d;++p){g=a[p];if(g.global||g.multiline)throw Error(""+g);n.push("(?:"+y(g)+")")}return RegExp(n.join("|"),l?"gi":"g")}function M(a){function m(a){switch(a.nodeType){case 1:if(e.test(a.className))break;for(var g=a.firstChild;g;g=g.nextSibling)m(g);g=a.nodeName;if("BR"===g||"LI"===g)h[s]="\n",t[s<<1]=y++,t[s++<<1|1]=a;break;case 3:case 4:g=a.nodeValue,g.length&&(g=p?g.replace(/\r\n?/g,"\n"):g.replace(/[\t\n\r ]+/g," "),h[s]=g,t[s<<1]=y,y+=g.length,
|
||||
t[s++<<1|1]=a)}}var e=/(?:^|\s)nocode(?:\s|$)/,h=[],y=0,t=[],s=0,l;a.currentStyle?l=a.currentStyle.whiteSpace:window.getComputedStyle&&(l=document.defaultView.getComputedStyle(a,q).getPropertyValue("white-space"));var p=l&&"pre"===l.substring(0,3);m(a);return{a:h.join("").replace(/\n$/,""),c:t}}function B(a,m,e,h){m&&(a={a:m,d:a},e(a),h.push.apply(h,a.e))}function x(a,m){function e(a){for(var l=a.d,p=[l,"pln"],d=0,g=a.a.match(y)||[],r={},n=0,z=g.length;n<z;++n){var f=g[n],b=r[f],o=void 0,c;if(typeof b===
|
||||
"string")c=!1;else{var i=h[f.charAt(0)];if(i)o=f.match(i[1]),b=i[0];else{for(c=0;c<t;++c)if(i=m[c],o=f.match(i[1])){b=i[0];break}o||(b="pln")}if((c=b.length>=5&&"lang-"===b.substring(0,5))&&!(o&&typeof o[1]==="string"))c=!1,b="src";c||(r[f]=b)}i=d;d+=f.length;if(c){c=o[1];var j=f.indexOf(c),k=j+c.length;o[2]&&(k=f.length-o[2].length,j=k-c.length);b=b.substring(5);B(l+i,f.substring(0,j),e,p);B(l+i+j,c,C(b,c),p);B(l+i+k,f.substring(k),e,p)}else p.push(l+i,b)}a.e=p}var h={},y;(function(){for(var e=a.concat(m),
|
||||
l=[],p={},d=0,g=e.length;d<g;++d){var r=e[d],n=r[3];if(n)for(var k=n.length;--k>=0;)h[n.charAt(k)]=r;r=r[1];n=""+r;p.hasOwnProperty(n)||(l.push(r),p[n]=q)}l.push(/[\S\s]/);y=L(l)})();var t=m.length;return e}function u(a){var m=[],e=[];a.tripleQuotedStrings?m.push(["str",/^(?:'''(?:[^'\\]|\\[\S\s]|''?(?=[^']))*(?:'''|$)|"""(?:[^"\\]|\\[\S\s]|""?(?=[^"]))*(?:"""|$)|'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$))/,q,"'\""]):a.multiLineStrings?m.push(["str",/^(?:'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$)|`(?:[^\\`]|\\[\S\s])*(?:`|$))/,
|
||||
q,"'\"`"]):m.push(["str",/^(?:'(?:[^\n\r'\\]|\\.)*(?:'|$)|"(?:[^\n\r"\\]|\\.)*(?:"|$))/,q,"\"'"]);a.verbatimStrings&&e.push(["str",/^@"(?:[^"]|"")*(?:"|$)/,q]);var h=a.hashComments;h&&(a.cStyleComments?(h>1?m.push(["com",/^#(?:##(?:[^#]|#(?!##))*(?:###|$)|.*)/,q,"#"]):m.push(["com",/^#(?:(?:define|elif|else|endif|error|ifdef|include|ifndef|line|pragma|undef|warning)\b|[^\n\r]*)/,q,"#"]),e.push(["str",/^<(?:(?:(?:\.\.\/)*|\/?)(?:[\w-]+(?:\/[\w-]+)+)?[\w-]+\.h|[a-z]\w*)>/,q])):m.push(["com",/^#[^\n\r]*/,
|
||||
q,"#"]));a.cStyleComments&&(e.push(["com",/^\/\/[^\n\r]*/,q]),e.push(["com",/^\/\*[\S\s]*?(?:\*\/|$)/,q]));a.regexLiterals&&e.push(["lang-regex",/^(?:^^\.?|[!+-]|!=|!==|#|%|%=|&|&&|&&=|&=|\(|\*|\*=|\+=|,|-=|->|\/|\/=|:|::|;|<|<<|<<=|<=|=|==|===|>|>=|>>|>>=|>>>|>>>=|[?@[^]|\^=|\^\^|\^\^=|{|\||\|=|\|\||\|\|=|~|break|case|continue|delete|do|else|finally|instanceof|return|throw|try|typeof)\s*(\/(?=[^*/])(?:[^/[\\]|\\[\S\s]|\[(?:[^\\\]]|\\[\S\s])*(?:]|$))+\/)/]);(h=a.types)&&e.push(["typ",h]);a=(""+a.keywords).replace(/^ | $/g,
|
||||
"");a.length&&e.push(["kwd",RegExp("^(?:"+a.replace(/[\s,]+/g,"|")+")\\b"),q]);m.push(["pln",/^\s+/,q," \r\n\t\xa0"]);e.push(["lit",/^@[$_a-z][\w$@]*/i,q],["typ",/^(?:[@_]?[A-Z]+[a-z][\w$@]*|\w+_t\b)/,q],["pln",/^[$_a-z][\w$@]*/i,q],["lit",/^(?:0x[\da-f]+|(?:\d(?:_\d+)*\d*(?:\.\d*)?|\.\d\+)(?:e[+-]?\d+)?)[a-z]*/i,q,"0123456789"],["pln",/^\\[\S\s]?/,q],["pun",/^.[^\s\w"-$'./@\\`]*/,q]);return x(m,e)}function D(a,m){function e(a){switch(a.nodeType){case 1:if(k.test(a.className))break;if("BR"===a.nodeName)h(a),
|
||||
a.parentNode&&a.parentNode.removeChild(a);else for(a=a.firstChild;a;a=a.nextSibling)e(a);break;case 3:case 4:if(p){var b=a.nodeValue,d=b.match(t);if(d){var c=b.substring(0,d.index);a.nodeValue=c;(b=b.substring(d.index+d[0].length))&&a.parentNode.insertBefore(s.createTextNode(b),a.nextSibling);h(a);c||a.parentNode.removeChild(a)}}}}function h(a){function b(a,d){var e=d?a.cloneNode(!1):a,f=a.parentNode;if(f){var f=b(f,1),g=a.nextSibling;f.appendChild(e);for(var h=g;h;h=g)g=h.nextSibling,f.appendChild(h)}return e}
|
||||
for(;!a.nextSibling;)if(a=a.parentNode,!a)return;for(var a=b(a.nextSibling,0),e;(e=a.parentNode)&&e.nodeType===1;)a=e;d.push(a)}var k=/(?:^|\s)nocode(?:\s|$)/,t=/\r\n?|\n/,s=a.ownerDocument,l;a.currentStyle?l=a.currentStyle.whiteSpace:window.getComputedStyle&&(l=s.defaultView.getComputedStyle(a,q).getPropertyValue("white-space"));var p=l&&"pre"===l.substring(0,3);for(l=s.createElement("LI");a.firstChild;)l.appendChild(a.firstChild);for(var d=[l],g=0;g<d.length;++g)e(d[g]);m===(m|0)&&d[0].setAttribute("value",
|
||||
m);var r=s.createElement("OL");r.className="linenums";for(var n=Math.max(0,m-1|0)||0,g=0,z=d.length;g<z;++g)l=d[g],l.className="L"+(g+n)%10,l.firstChild||l.appendChild(s.createTextNode("\xa0")),r.appendChild(l);a.appendChild(r)}function k(a,m){for(var e=m.length;--e>=0;){var h=m[e];A.hasOwnProperty(h)?window.console&&console.warn("cannot override language handler %s",h):A[h]=a}}function C(a,m){if(!a||!A.hasOwnProperty(a))a=/^\s*</.test(m)?"default-markup":"default-code";return A[a]}function E(a){var m=
|
||||
a.g;try{var e=M(a.h),h=e.a;a.a=h;a.c=e.c;a.d=0;C(m,h)(a);var k=/\bMSIE\b/.test(navigator.userAgent),m=/\n/g,t=a.a,s=t.length,e=0,l=a.c,p=l.length,h=0,d=a.e,g=d.length,a=0;d[g]=s;var r,n;for(n=r=0;n<g;)d[n]!==d[n+2]?(d[r++]=d[n++],d[r++]=d[n++]):n+=2;g=r;for(n=r=0;n<g;){for(var z=d[n],f=d[n+1],b=n+2;b+2<=g&&d[b+1]===f;)b+=2;d[r++]=z;d[r++]=f;n=b}for(d.length=r;h<p;){var o=l[h+2]||s,c=d[a+2]||s,b=Math.min(o,c),i=l[h+1],j;if(i.nodeType!==1&&(j=t.substring(e,b))){k&&(j=j.replace(m,"\r"));i.nodeValue=
|
||||
j;var u=i.ownerDocument,v=u.createElement("SPAN");v.className=d[a+1];var x=i.parentNode;x.replaceChild(v,i);v.appendChild(i);e<o&&(l[h+1]=i=u.createTextNode(t.substring(b,o)),x.insertBefore(i,v.nextSibling))}e=b;e>=o&&(h+=2);e>=c&&(a+=2)}}catch(w){"console"in window&&console.log(w&&w.stack?w.stack:w)}}var v=["break,continue,do,else,for,if,return,while"],w=[[v,"auto,case,char,const,default,double,enum,extern,float,goto,int,long,register,short,signed,sizeof,static,struct,switch,typedef,union,unsigned,void,volatile"],
|
||||
"catch,class,delete,false,import,new,operator,private,protected,public,this,throw,true,try,typeof"],F=[w,"alignof,align_union,asm,axiom,bool,concept,concept_map,const_cast,constexpr,decltype,dynamic_cast,explicit,export,friend,inline,late_check,mutable,namespace,nullptr,reinterpret_cast,static_assert,static_cast,template,typeid,typename,using,virtual,where"],G=[w,"abstract,boolean,byte,extends,final,finally,implements,import,instanceof,null,native,package,strictfp,super,synchronized,throws,transient"],
|
||||
H=[G,"as,base,by,checked,decimal,delegate,descending,dynamic,event,fixed,foreach,from,group,implicit,in,interface,internal,into,is,lock,object,out,override,orderby,params,partial,readonly,ref,sbyte,sealed,stackalloc,string,select,uint,ulong,unchecked,unsafe,ushort,var"],w=[w,"debugger,eval,export,function,get,null,set,undefined,var,with,Infinity,NaN"],I=[v,"and,as,assert,class,def,del,elif,except,exec,finally,from,global,import,in,is,lambda,nonlocal,not,or,pass,print,raise,try,with,yield,False,True,None"],
|
||||
J=[v,"alias,and,begin,case,class,def,defined,elsif,end,ensure,false,in,module,next,nil,not,or,redo,rescue,retry,self,super,then,true,undef,unless,until,when,yield,BEGIN,END"],v=[v,"case,done,elif,esac,eval,fi,function,in,local,set,then,until"],K=/^(DIR|FILE|vector|(de|priority_)?queue|list|stack|(const_)?iterator|(multi)?(set|map)|bitset|u?(int|float)\d*)/,N=/\S/,O=u({keywords:[F,H,w,"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END"+
|
||||
I,J,v],hashComments:!0,cStyleComments:!0,multiLineStrings:!0,regexLiterals:!0}),A={};k(O,["default-code"]);k(x([],[["pln",/^[^<?]+/],["dec",/^<!\w[^>]*(?:>|$)/],["com",/^<\!--[\S\s]*?(?:--\>|$)/],["lang-",/^<\?([\S\s]+?)(?:\?>|$)/],["lang-",/^<%([\S\s]+?)(?:%>|$)/],["pun",/^(?:<[%?]|[%?]>)/],["lang-",/^<xmp\b[^>]*>([\S\s]+?)<\/xmp\b[^>]*>/i],["lang-js",/^<script\b[^>]*>([\S\s]*?)(<\/script\b[^>]*>)/i],["lang-css",/^<style\b[^>]*>([\S\s]*?)(<\/style\b[^>]*>)/i],["lang-in.tag",/^(<\/?[a-z][^<>]*>)/i]]),
|
||||
["default-markup","htm","html","mxml","xhtml","xml","xsl"]);k(x([["pln",/^\s+/,q," \t\r\n"],["atv",/^(?:"[^"]*"?|'[^']*'?)/,q,"\"'"]],[["tag",/^^<\/?[a-z](?:[\w-.:]*\w)?|\/?>$/i],["atn",/^(?!style[\s=]|on)[a-z](?:[\w:-]*\w)?/i],["lang-uq.val",/^=\s*([^\s"'>]*(?:[^\s"'/>]|\/(?=\s)))/],["pun",/^[/<->]+/],["lang-js",/^on\w+\s*=\s*"([^"]+)"/i],["lang-js",/^on\w+\s*=\s*'([^']+)'/i],["lang-js",/^on\w+\s*=\s*([^\s"'>]+)/i],["lang-css",/^style\s*=\s*"([^"]+)"/i],["lang-css",/^style\s*=\s*'([^']+)'/i],["lang-css",
|
||||
/^style\s*=\s*([^\s"'>]+)/i]]),["in.tag"]);k(x([],[["atv",/^[\S\s]+/]]),["uq.val"]);k(u({keywords:F,hashComments:!0,cStyleComments:!0,types:K}),["c","cc","cpp","cxx","cyc","m"]);k(u({keywords:"null,true,false"}),["json"]);k(u({keywords:H,hashComments:!0,cStyleComments:!0,verbatimStrings:!0,types:K}),["cs"]);k(u({keywords:G,cStyleComments:!0}),["java"]);k(u({keywords:v,hashComments:!0,multiLineStrings:!0}),["bsh","csh","sh"]);k(u({keywords:I,hashComments:!0,multiLineStrings:!0,tripleQuotedStrings:!0}),
|
||||
["cv","py"]);k(u({keywords:"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END",hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["perl","pl","pm"]);k(u({keywords:J,hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["rb"]);k(u({keywords:w,cStyleComments:!0,regexLiterals:!0}),["js"]);k(u({keywords:"all,and,by,catch,class,else,extends,false,finally,for,if,in,is,isnt,loop,new,no,not,null,of,off,on,or,return,super,then,true,try,unless,until,when,while,yes",
|
||||
hashComments:3,cStyleComments:!0,multilineStrings:!0,tripleQuotedStrings:!0,regexLiterals:!0}),["coffee"]);k(x([],[["str",/^[\S\s]+/]]),["regex"]);window.prettyPrintOne=function(a,m,e){var h=document.createElement("PRE");h.innerHTML=a;e&&D(h,e);E({g:m,i:e,h:h});return h.innerHTML};window.prettyPrint=function(a){function m(){for(var e=window.PR_SHOULD_USE_CONTINUATION?l.now()+250:Infinity;p<h.length&&l.now()<e;p++){var n=h[p],k=n.className;if(k.indexOf("prettyprint")>=0){var k=k.match(g),f,b;if(b=
|
||||
!k){b=n;for(var o=void 0,c=b.firstChild;c;c=c.nextSibling)var i=c.nodeType,o=i===1?o?b:c:i===3?N.test(c.nodeValue)?b:o:o;b=(f=o===b?void 0:o)&&"CODE"===f.tagName}b&&(k=f.className.match(g));k&&(k=k[1]);b=!1;for(o=n.parentNode;o;o=o.parentNode)if((o.tagName==="pre"||o.tagName==="code"||o.tagName==="xmp")&&o.className&&o.className.indexOf("prettyprint")>=0){b=!0;break}b||((b=(b=n.className.match(/\blinenums\b(?::(\d+))?/))?b[1]&&b[1].length?+b[1]:!0:!1)&&D(n,b),d={g:k,h:n,i:b},E(d))}}p<h.length?setTimeout(m,
|
||||
250):a&&a()}for(var e=[document.getElementsByTagName("pre"),document.getElementsByTagName("code"),document.getElementsByTagName("xmp")],h=[],k=0;k<e.length;++k)for(var t=0,s=e[k].length;t<s;++t)h.push(e[k][t]);var e=q,l=Date;l.now||(l={now:function(){return+new Date}});var p=0,d,g=/\blang(?:uage)?-([\w.]+)(?!\S)/;m()};window.PR={createSimpleLexer:x,registerLangHandler:k,sourceDecorator:u,PR_ATTRIB_NAME:"atn",PR_ATTRIB_VALUE:"atv",PR_COMMENT:"com",PR_DECLARATION:"dec",PR_KEYWORD:"kwd",PR_LITERAL:"lit",
|
||||
PR_NOCODE:"nocode",PR_PLAIN:"pln",PR_PUNCTUATION:"pun",PR_SOURCE:"src",PR_STRING:"str",PR_TAG:"tag",PR_TYPE:"typ"}})();
|
||||
692
docs/picasa/1.0.7/styles/jsdoc-default.css
Normal file
@@ -0,0 +1,692 @@
|
||||
@import url(https://fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,400i,500i,500,600,600i|Roboto);
|
||||
|
||||
* {
|
||||
box-sizing: border-box
|
||||
}
|
||||
|
||||
html, body {
|
||||
height: 100%;
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
body {
|
||||
color: #4d4e53;
|
||||
background-color: white;
|
||||
margin: 0 auto;
|
||||
padding: 0;
|
||||
font-family: 'Source Sans Pro', Helvetica, sans-serif;
|
||||
font-size: 16px;
|
||||
line-height: 160%;
|
||||
}
|
||||
|
||||
a,
|
||||
a:active {
|
||||
color: #0095dd;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
a:hover {
|
||||
text-decoration: underline
|
||||
}
|
||||
|
||||
p, ul, ol, blockquote {
|
||||
margin-bottom: 1em;
|
||||
}
|
||||
|
||||
h1, h2, h3, h4, h5, h6 {
|
||||
font-family: 'Roboto', sans-serif;
|
||||
}
|
||||
|
||||
h1, h2, h3, h4, h5, h6 {
|
||||
color: #000;
|
||||
font-weight: 400;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
h1 {
|
||||
font-weight: 300;
|
||||
font-size: 48px;
|
||||
margin: 1em 0 .5em;
|
||||
}
|
||||
|
||||
h1.page-title {margin-bottom: 10px;font-size: 34px;font-weight: 300;border-bottom: solid 2px #ddd;padding: .5em 0 .5em;margin-top: 0;}
|
||||
|
||||
h2 {
|
||||
font-size: 32px;
|
||||
margin: 1.2em 0 .8em;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
h3 {
|
||||
/* margin-top: 1em; */
|
||||
/* margin-bottom: 16px; */
|
||||
/* font-weight: bold; */
|
||||
padding: 0;
|
||||
margin: 1em 0 .6em;
|
||||
font-size: 28px;
|
||||
/* border-bottom: 1px solid #eee; */
|
||||
/* padding-bottom: 15px; */
|
||||
}
|
||||
|
||||
h4 {
|
||||
font-size: 18px;
|
||||
margin: 1em 0 .2em;
|
||||
color: #4d4e53;
|
||||
/* border-bottom: 1px solid #eee; */
|
||||
padding-bottom: 8px;
|
||||
}
|
||||
|
||||
h5, .container-overview .subsection-title {
|
||||
font-size: 120%;
|
||||
/* letter-spacing: -0.01em; */
|
||||
margin: 20px 0 5px;
|
||||
}
|
||||
|
||||
h6 {
|
||||
font-size: 100%;
|
||||
letter-spacing: -0.01em;
|
||||
margin: 6px 0 3px 0;
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
tt, code, kbd, samp {
|
||||
font-family: Consolas, Monaco, 'Andale Mono', monospace;
|
||||
background: #f4f4f4;
|
||||
padding: 1px 5px;
|
||||
border-radius: 5px;
|
||||
font-size: 14px;
|
||||
}
|
||||
|
||||
blockquote {
|
||||
display: block;
|
||||
border-left: 4px solid #eee;
|
||||
margin: 0;
|
||||
padding-left: 1em;
|
||||
color: #888;
|
||||
}
|
||||
|
||||
.class-description {
|
||||
font-size: 130%;
|
||||
line-height: 140%;
|
||||
margin-bottom: 1em;
|
||||
margin-top: 1em;
|
||||
}
|
||||
|
||||
.class-description:empty {
|
||||
margin: 0
|
||||
}
|
||||
|
||||
/** Container **/
|
||||
#main {
|
||||
float: right;
|
||||
min-width: 360px;
|
||||
width: calc(100% - 250px);
|
||||
padding: 0 30px 20px 30px;
|
||||
}
|
||||
|
||||
header {
|
||||
display: block
|
||||
}
|
||||
|
||||
section {
|
||||
display: block;
|
||||
background-color: #fff;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
.variation {
|
||||
display: none
|
||||
}
|
||||
|
||||
.signature-attributes {
|
||||
font-size: 60%;
|
||||
color: #aaa;
|
||||
font-style: italic;
|
||||
font-weight: lighter;
|
||||
}
|
||||
|
||||
/** Readme **/
|
||||
|
||||
.readme {
|
||||
font-size: 16px;
|
||||
}
|
||||
|
||||
.readme h1,
|
||||
.readme h2,
|
||||
.readme h3,
|
||||
.readme h4,
|
||||
.readme h5 {
|
||||
margin-top: 1em;
|
||||
margin-bottom: 16px;
|
||||
font-weight: bold;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
.readme h1 {
|
||||
font-size: 2em;
|
||||
padding-bottom: 0.3em;
|
||||
}
|
||||
|
||||
.readme h2 {
|
||||
font-size: 1.75em;
|
||||
padding-bottom: 0.3em;
|
||||
}
|
||||
|
||||
.readme h3 {
|
||||
font-size: 1.5em;
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
.readme h4 {
|
||||
font-size: 1.25em;
|
||||
}
|
||||
|
||||
.readme h5 {
|
||||
font-size: 1em;
|
||||
}
|
||||
|
||||
.readme img {
|
||||
max-width: 100%;
|
||||
}
|
||||
|
||||
.readme ul, .readme ol {
|
||||
padding-left: 2em;
|
||||
}
|
||||
|
||||
.readme pre > code {
|
||||
font-size: 0.85em;
|
||||
}
|
||||
|
||||
.readme table {
|
||||
margin-bottom: 1em;
|
||||
border-collapse: collapse;
|
||||
border-spacing: 0;
|
||||
}
|
||||
|
||||
.readme table tr {
|
||||
background-color: #fff;
|
||||
border-top: 1px solid #ccc;
|
||||
}
|
||||
|
||||
.readme table th,
|
||||
.readme table td {
|
||||
padding: 6px 13px;
|
||||
border: 1px solid #ddd;
|
||||
}
|
||||
|
||||
.readme table tr:nth-child(2n) {
|
||||
background-color: #f8f8f8;
|
||||
}
|
||||
|
||||
/** Nav **/
|
||||
nav {
|
||||
float: left;
|
||||
display: block;
|
||||
width: 250px;
|
||||
background: #fff;
|
||||
overflow: auto;
|
||||
position: fixed;
|
||||
height: 100%;
|
||||
padding: 10px;
|
||||
border-right: 1px solid #eee;
|
||||
/* box-shadow: 0 0 3px rgba(0,0,0,0.1); */
|
||||
}
|
||||
|
||||
nav li {
|
||||
list-style: none;
|
||||
padding: 0;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
.nav-heading {
|
||||
margin-top: 10px;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
.nav-heading a {
|
||||
color: #888;
|
||||
font-size: 14px;
|
||||
display: inline-block;
|
||||
}
|
||||
|
||||
.nav-item-type {
|
||||
/* margin-left: 5px; */
|
||||
width: 18px;
|
||||
height: 18px;
|
||||
display: inline-block;
|
||||
text-align: center;
|
||||
border-radius: 0.2em;
|
||||
margin-right: 5px;
|
||||
font-weight: bold;
|
||||
line-height: 20px;
|
||||
font-size: 13px;
|
||||
}
|
||||
|
||||
.type-function {
|
||||
background: #B3E5FC;
|
||||
color: #0288D1;
|
||||
}
|
||||
|
||||
.type-class {
|
||||
background: #D1C4E9;
|
||||
color: #4527A0;
|
||||
}
|
||||
|
||||
.type-member {
|
||||
background: #C8E6C9;
|
||||
color: #388E3C;
|
||||
}
|
||||
|
||||
.type-module {
|
||||
background: #E1BEE7;
|
||||
color: #7B1FA2;
|
||||
}
|
||||
|
||||
|
||||
/** Footer **/
|
||||
footer {
|
||||
color: hsl(0, 0%, 28%);
|
||||
margin-left: 250px;
|
||||
display: block;
|
||||
padding: 30px;
|
||||
font-style: italic;
|
||||
font-size: 90%;
|
||||
border-top: 1px solid #eee;
|
||||
}
|
||||
|
||||
.ancestors {
|
||||
color: #999
|
||||
}
|
||||
|
||||
.ancestors a {
|
||||
color: #999 !important;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
.clear {
|
||||
clear: both
|
||||
}
|
||||
|
||||
.important {
|
||||
font-weight: bold;
|
||||
color: #950B02;
|
||||
}
|
||||
|
||||
.yes-def {
|
||||
text-indent: -1000px
|
||||
}
|
||||
|
||||
.type-signature {
|
||||
color: #aaa
|
||||
}
|
||||
|
||||
.name, .signature {
|
||||
font-family: Consolas, Monaco, 'Andale Mono', monospace
|
||||
}
|
||||
|
||||
.details {
|
||||
margin-top: 14px;
|
||||
border-left: 2px solid #DDD;
|
||||
line-height: 30px;
|
||||
}
|
||||
|
||||
.details dt {
|
||||
width: 120px;
|
||||
float: left;
|
||||
padding-left: 10px;
|
||||
}
|
||||
|
||||
.details dd {
|
||||
margin-left: 70px
|
||||
}
|
||||
|
||||
.details ul {
|
||||
margin: 0
|
||||
}
|
||||
|
||||
.details ul {
|
||||
list-style-type: none
|
||||
}
|
||||
|
||||
.details li {
|
||||
margin-left: 30px
|
||||
}
|
||||
|
||||
.details pre.prettyprint {
|
||||
margin: 0
|
||||
}
|
||||
|
||||
.details .object-value {
|
||||
padding-top: 0
|
||||
}
|
||||
|
||||
.description {
|
||||
margin-bottom: 1em;
|
||||
margin-top: 1em;
|
||||
}
|
||||
|
||||
.code-caption {
|
||||
font-style: italic;
|
||||
font-size: 107%;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
.prettyprint {
|
||||
font-size: 13px;
|
||||
border: 1px solid #ddd;
|
||||
border-radius: 3px;
|
||||
box-shadow: 0 1px 3px hsla(0, 0%, 0%, 0.05);
|
||||
overflow: auto;
|
||||
}
|
||||
|
||||
.prettyprint.source {
|
||||
width: inherit
|
||||
}
|
||||
|
||||
.prettyprint code {
|
||||
font-size: 12px;
|
||||
line-height: 18px;
|
||||
display: block;
|
||||
background-color: #fff;
|
||||
color: #4D4E53;
|
||||
}
|
||||
|
||||
.prettyprint code:empty:before {
|
||||
content: '';
|
||||
}
|
||||
|
||||
.prettyprint > code {
|
||||
padding: 15px
|
||||
}
|
||||
|
||||
.prettyprint .linenums code {
|
||||
padding: 0 15px
|
||||
}
|
||||
|
||||
.prettyprint .linenums li:first-of-type code {
|
||||
padding-top: 15px
|
||||
}
|
||||
|
||||
.prettyprint code span.line {
|
||||
display: inline-block
|
||||
}
|
||||
|
||||
.prettyprint.linenums {
|
||||
padding-left: 70px;
|
||||
-webkit-user-select: none;
|
||||
-moz-user-select: none;
|
||||
-ms-user-select: none;
|
||||
user-select: none;
|
||||
}
|
||||
|
||||
.prettyprint.linenums ol {
|
||||
padding-left: 0
|
||||
}
|
||||
|
||||
.prettyprint.linenums li {
|
||||
border-left: 3px #ddd solid
|
||||
}
|
||||
|
||||
.prettyprint.linenums li.selected, .prettyprint.linenums li.selected * {
|
||||
background-color: lightyellow
|
||||
}
|
||||
|
||||
.prettyprint.linenums li * {
|
||||
-webkit-user-select: text;
|
||||
-moz-user-select: text;
|
||||
-ms-user-select: text;
|
||||
user-select: text;
|
||||
}
|
||||
|
||||
.params, .props {
|
||||
border-spacing: 0;
|
||||
border: 1px solid #ddd;
|
||||
border-collapse: collapse;
|
||||
border-radius: 3px;
|
||||
box-shadow: 0 1px 3px rgba(0,0,0,0.1);
|
||||
width: 100%;
|
||||
font-size: 14px;
|
||||
/* margin-left: 15px; */
|
||||
}
|
||||
|
||||
.params .name, .props .name, .name code {
|
||||
color: #4D4E53;
|
||||
font-family: Consolas, Monaco, 'Andale Mono', monospace;
|
||||
font-size: 100%;
|
||||
}
|
||||
|
||||
.params td, .params th, .props td, .props th {
|
||||
margin: 0px;
|
||||
text-align: left;
|
||||
vertical-align: top;
|
||||
padding: 10px;
|
||||
display: table-cell;
|
||||
}
|
||||
|
||||
.params td {
|
||||
border-top: 1px solid #eee
|
||||
}
|
||||
|
||||
.params thead tr, .props thead tr {
|
||||
background-color: #fff;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
.params .params thead tr, .props .props thead tr {
|
||||
background-color: #fff;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
.params td.description > p:first-child, .props td.description > p:first-child {
|
||||
margin-top: 0;
|
||||
padding-top: 0;
|
||||
}
|
||||
|
||||
.params td.description > p:last-child, .props td.description > p:last-child {
|
||||
margin-bottom: 0;
|
||||
padding-bottom: 0;
|
||||
}
|
||||
|
||||
dl.param-type {
|
||||
/* border-bottom: 1px solid hsl(0, 0%, 87%); */
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
font-size: 16px;
|
||||
}
|
||||
|
||||
.param-type dt, .param-type dd {
|
||||
display: inline-block
|
||||
}
|
||||
|
||||
.param-type dd {
|
||||
font-family: Consolas, Monaco, 'Andale Mono', monospace;
|
||||
display: inline-block;
|
||||
padding: 0;
|
||||
margin: 0;
|
||||
font-size: 14px;
|
||||
}
|
||||
|
||||
.disabled {
|
||||
color: #454545
|
||||
}
|
||||
|
||||
/* navicon button */
|
||||
.navicon-button {
|
||||
display: none;
|
||||
position: relative;
|
||||
padding: 2.0625rem 1.5rem;
|
||||
transition: 0.25s;
|
||||
cursor: pointer;
|
||||
user-select: none;
|
||||
opacity: .8;
|
||||
}
|
||||
.navicon-button .navicon:before, .navicon-button .navicon:after {
|
||||
transition: 0.25s;
|
||||
}
|
||||
.navicon-button:hover {
|
||||
transition: 0.5s;
|
||||
opacity: 1;
|
||||
}
|
||||
.navicon-button:hover .navicon:before, .navicon-button:hover .navicon:after {
|
||||
transition: 0.25s;
|
||||
}
|
||||
.navicon-button:hover .navicon:before {
|
||||
top: .825rem;
|
||||
}
|
||||
.navicon-button:hover .navicon:after {
|
||||
top: -.825rem;
|
||||
}
|
||||
|
||||
/* navicon */
|
||||
.navicon {
|
||||
position: relative;
|
||||
width: 2.5em;
|
||||
height: .3125rem;
|
||||
background: #000;
|
||||
transition: 0.3s;
|
||||
border-radius: 2.5rem;
|
||||
}
|
||||
.navicon:before, .navicon:after {
|
||||
display: block;
|
||||
content: "";
|
||||
height: .3125rem;
|
||||
width: 2.5rem;
|
||||
background: #000;
|
||||
position: absolute;
|
||||
z-index: -1;
|
||||
transition: 0.3s 0.25s;
|
||||
border-radius: 1rem;
|
||||
}
|
||||
.navicon:before {
|
||||
top: .625rem;
|
||||
}
|
||||
.navicon:after {
|
||||
top: -.625rem;
|
||||
}
|
||||
|
||||
/* open */
|
||||
.nav-trigger:checked + label:not(.steps) .navicon:before,
|
||||
.nav-trigger:checked + label:not(.steps) .navicon:after {
|
||||
top: 0 !important;
|
||||
}
|
||||
|
||||
.nav-trigger:checked + label .navicon:before,
|
||||
.nav-trigger:checked + label .navicon:after {
|
||||
transition: 0.5s;
|
||||
}
|
||||
|
||||
/* Minus */
|
||||
.nav-trigger:checked + label {
|
||||
transform: scale(0.75);
|
||||
}
|
||||
|
||||
/* Ã and + */
|
||||
.nav-trigger:checked + label.plus .navicon,
|
||||
.nav-trigger:checked + label.x .navicon {
|
||||
background: transparent;
|
||||
}
|
||||
|
||||
.nav-trigger:checked + label.plus .navicon:before,
|
||||
.nav-trigger:checked + label.x .navicon:before {
|
||||
transform: rotate(-45deg);
|
||||
background: #FFF;
|
||||
}
|
||||
|
||||
.nav-trigger:checked + label.plus .navicon:after,
|
||||
.nav-trigger:checked + label.x .navicon:after {
|
||||
transform: rotate(45deg);
|
||||
background: #FFF;
|
||||
}
|
||||
|
||||
.nav-trigger:checked + label.plus {
|
||||
transform: scale(0.75) rotate(45deg);
|
||||
}
|
||||
|
||||
.nav-trigger:checked ~ nav {
|
||||
left: 0 !important;
|
||||
}
|
||||
|
||||
.nav-trigger:checked ~ .overlay {
|
||||
display: block;
|
||||
}
|
||||
|
||||
.nav-trigger {
|
||||
position: fixed;
|
||||
top: 0;
|
||||
clip: rect(0, 0, 0, 0);
|
||||
}
|
||||
|
||||
.overlay {
|
||||
display: none;
|
||||
position: fixed;
|
||||
top: 0;
|
||||
bottom: 0;
|
||||
left: 0;
|
||||
right: 0;
|
||||
width: 100%;
|
||||
height: 100%;
|
||||
background: hsla(0, 0%, 0%, 0.5);
|
||||
z-index: 1;
|
||||
}
|
||||
|
||||
.section-method {
|
||||
margin-bottom: 30px;
|
||||
padding-bottom: 30px;
|
||||
border-bottom: 1px solid #eee;
|
||||
}
|
||||
|
||||
@media only screen and (min-width: 320px) and (max-width: 680px) {
|
||||
body {
|
||||
overflow-x: hidden;
|
||||
}
|
||||
|
||||
nav {
|
||||
background: #FFF;
|
||||
width: 250px;
|
||||
height: 100%;
|
||||
position: fixed;
|
||||
top: 0;
|
||||
right: 0;
|
||||
bottom: 0;
|
||||
left: -250px;
|
||||
z-index: 3;
|
||||
padding: 0 10px;
|
||||
transition: left 0.2s;
|
||||
}
|
||||
|
||||
.navicon-button {
|
||||
display: inline-block;
|
||||
position: fixed;
|
||||
top: 1.5em;
|
||||
right: 0;
|
||||
z-index: 2;
|
||||
}
|
||||
|
||||
#main {
|
||||
width: 100%;
|
||||
min-width: 360px;
|
||||
}
|
||||
|
||||
#main h1.page-title {
|
||||
margin: 1em 0;
|
||||
}
|
||||
|
||||
#main section {
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
footer {
|
||||
margin-left: 0;
|
||||
}
|
||||
}
|
||||
|
||||
@media only print {
|
||||
nav {
|
||||
display: none;
|
||||
}
|
||||
|
||||
#main {
|
||||
float: none;
|
||||
width: 100%;
|
||||
}
|
||||
}
|
||||
111
docs/picasa/1.0.7/styles/prettify-jsdoc.css
Normal file
@@ -0,0 +1,111 @@
|
||||
/* JSDoc prettify.js theme */
|
||||
|
||||
/* plain text */
|
||||
.pln {
|
||||
color: #000000;
|
||||
font-weight: normal;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* string content */
|
||||
.str {
|
||||
color: hsl(104, 100%, 24%);
|
||||
font-weight: normal;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* a keyword */
|
||||
.kwd {
|
||||
color: #000000;
|
||||
font-weight: bold;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* a comment */
|
||||
.com {
|
||||
font-weight: normal;
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
/* a type name */
|
||||
.typ {
|
||||
color: #000000;
|
||||
font-weight: normal;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* a literal value */
|
||||
.lit {
|
||||
color: #006400;
|
||||
font-weight: normal;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* punctuation */
|
||||
.pun {
|
||||
color: #000000;
|
||||
font-weight: bold;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* lisp open bracket */
|
||||
.opn {
|
||||
color: #000000;
|
||||
font-weight: bold;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* lisp close bracket */
|
||||
.clo {
|
||||
color: #000000;
|
||||
font-weight: bold;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* a markup tag name */
|
||||
.tag {
|
||||
color: #006400;
|
||||
font-weight: normal;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* a markup attribute name */
|
||||
.atn {
|
||||
color: #006400;
|
||||
font-weight: normal;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* a markup attribute value */
|
||||
.atv {
|
||||
color: #006400;
|
||||
font-weight: normal;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* a declaration */
|
||||
.dec {
|
||||
color: #000000;
|
||||
font-weight: bold;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* a variable name */
|
||||
.var {
|
||||
color: #000000;
|
||||
font-weight: normal;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* a function name */
|
||||
.fun {
|
||||
color: #000000;
|
||||
font-weight: bold;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* Specify class=linenums on a pre to get line numbering */
|
||||
ol.linenums {
|
||||
margin-top: 0;
|
||||
margin-bottom: 0;
|
||||
}
|
||||
132
docs/picasa/1.0.7/styles/prettify-tomorrow.css
Normal file
@@ -0,0 +1,132 @@
|
||||
/* Tomorrow Theme */
|
||||
/* Original theme - https://github.com/chriskempson/tomorrow-theme */
|
||||
/* Pretty printing styles. Used with prettify.js. */
|
||||
/* SPAN elements with the classes below are added by prettyprint. */
|
||||
/* plain text */
|
||||
.pln {
|
||||
color: #4d4d4c; }
|
||||
|
||||
@media screen {
|
||||
/* string content */
|
||||
.str {
|
||||
color: hsl(104, 100%, 24%); }
|
||||
|
||||
/* a keyword */
|
||||
.kwd {
|
||||
color: hsl(240, 100%, 50%); }
|
||||
|
||||
/* a comment */
|
||||
.com {
|
||||
color: hsl(0, 0%, 60%); }
|
||||
|
||||
/* a type name */
|
||||
.typ {
|
||||
color: hsl(240, 100%, 32%); }
|
||||
|
||||
/* a literal value */
|
||||
.lit {
|
||||
color: hsl(240, 100%, 40%); }
|
||||
|
||||
/* punctuation */
|
||||
.pun {
|
||||
color: #000000; }
|
||||
|
||||
/* lisp open bracket */
|
||||
.opn {
|
||||
color: #000000; }
|
||||
|
||||
/* lisp close bracket */
|
||||
.clo {
|
||||
color: #000000; }
|
||||
|
||||
/* a markup tag name */
|
||||
.tag {
|
||||
color: #c82829; }
|
||||
|
||||
/* a markup attribute name */
|
||||
.atn {
|
||||
color: #f5871f; }
|
||||
|
||||
/* a markup attribute value */
|
||||
.atv {
|
||||
color: #3e999f; }
|
||||
|
||||
/* a declaration */
|
||||
.dec {
|
||||
color: #f5871f; }
|
||||
|
||||
/* a variable name */
|
||||
.var {
|
||||
color: #c82829; }
|
||||
|
||||
/* a function name */
|
||||
.fun {
|
||||
color: #4271ae; } }
|
||||
/* Use higher contrast and text-weight for printable form. */
|
||||
@media print, projection {
|
||||
.str {
|
||||
color: #060; }
|
||||
|
||||
.kwd {
|
||||
color: #006;
|
||||
font-weight: bold; }
|
||||
|
||||
.com {
|
||||
color: #600;
|
||||
font-style: italic; }
|
||||
|
||||
.typ {
|
||||
color: #404;
|
||||
font-weight: bold; }
|
||||
|
||||
.lit {
|
||||
color: #044; }
|
||||
|
||||
.pun, .opn, .clo {
|
||||
color: #440; }
|
||||
|
||||
.tag {
|
||||
color: #006;
|
||||
font-weight: bold; }
|
||||
|
||||
.atn {
|
||||
color: #404; }
|
||||
|
||||
.atv {
|
||||
color: #060; } }
|
||||
/* Style */
|
||||
/*
|
||||
pre.prettyprint {
|
||||
background: white;
|
||||
font-family: Consolas, Monaco, 'Andale Mono', monospace;
|
||||
font-size: 12px;
|
||||
line-height: 1.5;
|
||||
border: 1px solid #ccc;
|
||||
padding: 10px; }
|
||||
*/
|
||||
|
||||
/* Specify class=linenums on a pre to get line numbering */
|
||||
ol.linenums {
|
||||
margin-top: 0;
|
||||
margin-bottom: 0; }
|
||||
|
||||
/* IE indents via margin-left */
|
||||
li.L0,
|
||||
li.L1,
|
||||
li.L2,
|
||||
li.L3,
|
||||
li.L4,
|
||||
li.L5,
|
||||
li.L6,
|
||||
li.L7,
|
||||
li.L8,
|
||||
li.L9 {
|
||||
/* */ }
|
||||
|
||||
/* Alternate shading for lines */
|
||||
li.L1,
|
||||
li.L3,
|
||||
li.L5,
|
||||
li.L7,
|
||||
li.L9 {
|
||||
/* */ }
|
||||
25
docs/scripts/linenumber.js
Normal file
@@ -0,0 +1,25 @@
|
||||
/*global document */
|
||||
(function() {
|
||||
var source = document.getElementsByClassName('prettyprint source linenums');
|
||||
var i = 0;
|
||||
var lineNumber = 0;
|
||||
var lineId;
|
||||
var lines;
|
||||
var totalLines;
|
||||
var anchorHash;
|
||||
|
||||
if (source && source[0]) {
|
||||
anchorHash = document.location.hash.substring(1);
|
||||
lines = source[0].getElementsByTagName('li');
|
||||
totalLines = lines.length;
|
||||
|
||||
for (; i < totalLines; i++) {
|
||||
lineNumber++;
|
||||
lineId = 'line' + lineNumber;
|
||||
lines[i].id = lineId;
|
||||
if (lineId === anchorHash) {
|
||||
lines[i].className += ' selected';
|
||||
}
|
||||
}
|
||||
}
|
||||
})();
|
||||
202
docs/scripts/prettify/Apache-License-2.0.txt
Normal file
@@ -0,0 +1,202 @@
|
||||
|
||||
Apache License
|
||||
Version 2.0, January 2004
|
||||
http://www.apache.org/licenses/
|
||||
|
||||
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
||||
|
||||
1. Definitions.
|
||||
|
||||
"License" shall mean the terms and conditions for use, reproduction,
|
||||
and distribution as defined by Sections 1 through 9 of this document.
|
||||
|
||||
"Licensor" shall mean the copyright owner or entity authorized by
|
||||
the copyright owner that is granting the License.
|
||||
|
||||
"Legal Entity" shall mean the union of the acting entity and all
|
||||
other entities that control, are controlled by, or are under common
|
||||
control with that entity. For the purposes of this definition,
|
||||
"control" means (i) the power, direct or indirect, to cause the
|
||||
direction or management of such entity, whether by contract or
|
||||
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
||||
outstanding shares, or (iii) beneficial ownership of such entity.
|
||||
|
||||
"You" (or "Your") shall mean an individual or Legal Entity
|
||||
exercising permissions granted by this License.
|
||||
|
||||
"Source" form shall mean the preferred form for making modifications,
|
||||
including but not limited to software source code, documentation
|
||||
source, and configuration files.
|
||||
|
||||
"Object" form shall mean any form resulting from mechanical
|
||||
transformation or translation of a Source form, including but
|
||||
not limited to compiled object code, generated documentation,
|
||||
and conversions to other media types.
|
||||
|
||||
"Work" shall mean the work of authorship, whether in Source or
|
||||
Object form, made available under the License, as indicated by a
|
||||
copyright notice that is included in or attached to the work
|
||||
(an example is provided in the Appendix below).
|
||||
|
||||
"Derivative Works" shall mean any work, whether in Source or Object
|
||||
form, that is based on (or derived from) the Work and for which the
|
||||
editorial revisions, annotations, elaborations, or other modifications
|
||||
represent, as a whole, an original work of authorship. For the purposes
|
||||
of this License, Derivative Works shall not include works that remain
|
||||
separable from, or merely link (or bind by name) to the interfaces of,
|
||||
the Work and Derivative Works thereof.
|
||||
|
||||
"Contribution" shall mean any work of authorship, including
|
||||
the original version of the Work and any modifications or additions
|
||||
to that Work or Derivative Works thereof, that is intentionally
|
||||
submitted to Licensor for inclusion in the Work by the copyright owner
|
||||
or by an individual or Legal Entity authorized to submit on behalf of
|
||||
the copyright owner. For the purposes of this definition, "submitted"
|
||||
means any form of electronic, verbal, or written communication sent
|
||||
to the Licensor or its representatives, including but not limited to
|
||||
communication on electronic mailing lists, source code control systems,
|
||||
and issue tracking systems that are managed by, or on behalf of, the
|
||||
Licensor for the purpose of discussing and improving the Work, but
|
||||
excluding communication that is conspicuously marked or otherwise
|
||||
designated in writing by the copyright owner as "Not a Contribution."
|
||||
|
||||
"Contributor" shall mean Licensor and any individual or Legal Entity
|
||||
on behalf of whom a Contribution has been received by Licensor and
|
||||
subsequently incorporated within the Work.
|
||||
|
||||
2. Grant of Copyright License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
copyright license to reproduce, prepare Derivative Works of,
|
||||
publicly display, publicly perform, sublicense, and distribute the
|
||||
Work and such Derivative Works in Source or Object form.
|
||||
|
||||
3. Grant of Patent License. Subject to the terms and conditions of
|
||||
this License, each Contributor hereby grants to You a perpetual,
|
||||
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
||||
(except as stated in this section) patent license to make, have made,
|
||||
use, offer to sell, sell, import, and otherwise transfer the Work,
|
||||
where such license applies only to those patent claims licensable
|
||||
by such Contributor that are necessarily infringed by their
|
||||
Contribution(s) alone or by combination of their Contribution(s)
|
||||
with the Work to which such Contribution(s) was submitted. If You
|
||||
institute patent litigation against any entity (including a
|
||||
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
||||
or a Contribution incorporated within the Work constitutes direct
|
||||
or contributory patent infringement, then any patent licenses
|
||||
granted to You under this License for that Work shall terminate
|
||||
as of the date such litigation is filed.
|
||||
|
||||
4. Redistribution. You may reproduce and distribute copies of the
|
||||
Work or Derivative Works thereof in any medium, with or without
|
||||
modifications, and in Source or Object form, provided that You
|
||||
meet the following conditions:
|
||||
|
||||
(a) You must give any other recipients of the Work or
|
||||
Derivative Works a copy of this License; and
|
||||
|
||||
(b) You must cause any modified files to carry prominent notices
|
||||
stating that You changed the files; and
|
||||
|
||||
(c) You must retain, in the Source form of any Derivative Works
|
||||
that You distribute, all copyright, patent, trademark, and
|
||||
attribution notices from the Source form of the Work,
|
||||
excluding those notices that do not pertain to any part of
|
||||
the Derivative Works; and
|
||||
|
||||
(d) If the Work includes a "NOTICE" text file as part of its
|
||||
distribution, then any Derivative Works that You distribute must
|
||||
include a readable copy of the attribution notices contained
|
||||
within such NOTICE file, excluding those notices that do not
|
||||
pertain to any part of the Derivative Works, in at least one
|
||||
of the following places: within a NOTICE text file distributed
|
||||
as part of the Derivative Works; within the Source form or
|
||||
documentation, if provided along with the Derivative Works; or,
|
||||
within a display generated by the Derivative Works, if and
|
||||
wherever such third-party notices normally appear. The contents
|
||||
of the NOTICE file are for informational purposes only and
|
||||
do not modify the License. You may add Your own attribution
|
||||
notices within Derivative Works that You distribute, alongside
|
||||
or as an addendum to the NOTICE text from the Work, provided
|
||||
that such additional attribution notices cannot be construed
|
||||
as modifying the License.
|
||||
|
||||
You may add Your own copyright statement to Your modifications and
|
||||
may provide additional or different license terms and conditions
|
||||
for use, reproduction, or distribution of Your modifications, or
|
||||
for any such Derivative Works as a whole, provided Your use,
|
||||
reproduction, and distribution of the Work otherwise complies with
|
||||
the conditions stated in this License.
|
||||
|
||||
5. Submission of Contributions. Unless You explicitly state otherwise,
|
||||
any Contribution intentionally submitted for inclusion in the Work
|
||||
by You to the Licensor shall be under the terms and conditions of
|
||||
this License, without any additional terms or conditions.
|
||||
Notwithstanding the above, nothing herein shall supersede or modify
|
||||
the terms of any separate license agreement you may have executed
|
||||
with Licensor regarding such Contributions.
|
||||
|
||||
6. Trademarks. This License does not grant permission to use the trade
|
||||
names, trademarks, service marks, or product names of the Licensor,
|
||||
except as required for reasonable and customary use in describing the
|
||||
origin of the Work and reproducing the content of the NOTICE file.
|
||||
|
||||
7. Disclaimer of Warranty. Unless required by applicable law or
|
||||
agreed to in writing, Licensor provides the Work (and each
|
||||
Contributor provides its Contributions) on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
||||
implied, including, without limitation, any warranties or conditions
|
||||
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
appropriateness of using or redistributing the Work and assume any
|
||||
risks associated with Your exercise of permissions under this License.
|
||||
|
||||
8. Limitation of Liability. In no event and under no legal theory,
|
||||
whether in tort (including negligence), contract, or otherwise,
|
||||
unless required by applicable law (such as deliberate and grossly
|
||||
negligent acts) or agreed to in writing, shall any Contributor be
|
||||
liable to You for damages, including any direct, indirect, special,
|
||||
incidental, or consequential damages of any character arising as a
|
||||
result of this License or out of the use or inability to use the
|
||||
Work (including but not limited to damages for loss of goodwill,
|
||||
work stoppage, computer failure or malfunction, or any and all
|
||||
other commercial damages or losses), even if such Contributor
|
||||
has been advised of the possibility of such damages.
|
||||
|
||||
9. Accepting Warranty or Additional Liability. While redistributing
|
||||
the Work or Derivative Works thereof, You may choose to offer,
|
||||
and charge a fee for, acceptance of support, warranty, indemnity,
|
||||
or other liability obligations and/or rights consistent with this
|
||||
License. However, in accepting such obligations, You may act only
|
||||
on Your own behalf and on Your sole responsibility, not on behalf
|
||||
of any other Contributor, and only if You agree to indemnify,
|
||||
defend, and hold each Contributor harmless for any liability
|
||||
incurred by, or claims asserted against, such Contributor by reason
|
||||
of your accepting any such warranty or additional liability.
|
||||
|
||||
END OF TERMS AND CONDITIONS
|
||||
|
||||
APPENDIX: How to apply the Apache License to your work.
|
||||
|
||||
To apply the Apache License to your work, attach the following
|
||||
boilerplate notice, with the fields enclosed by brackets "[]"
|
||||
replaced with your own identifying information. (Don't include
|
||||
the brackets!) The text should be enclosed in the appropriate
|
||||
comment syntax for the file format. We also recommend that a
|
||||
file or class name and description of purpose be included on the
|
||||
same "printed page" as the copyright notice for easier
|
||||
identification within third-party archives.
|
||||
|
||||
Copyright [yyyy] [name of copyright owner]
|
||||
|
||||
Licensed under the Apache License, Version 2.0 (the "License");
|
||||
you may not use this file except in compliance with the License.
|
||||
You may obtain a copy of the License at
|
||||
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
Unless required by applicable law or agreed to in writing, software
|
||||
distributed under the License is distributed on an "AS IS" BASIS,
|
||||
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
See the License for the specific language governing permissions and
|
||||
limitations under the License.
|
||||
2
docs/scripts/prettify/lang-css.js
Normal file
@@ -0,0 +1,2 @@
|
||||
PR.registerLangHandler(PR.createSimpleLexer([["pln",/^[\t\n\f\r ]+/,null," \t\r\n"]],[["str",/^"(?:[^\n\f\r"\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*"/,null],["str",/^'(?:[^\n\f\r'\\]|\\(?:\r\n?|\n|\f)|\\[\S\s])*'/,null],["lang-css-str",/^url\(([^"')]*)\)/i],["kwd",/^(?:url|rgb|!important|@import|@page|@media|@charset|inherit)(?=[^\w-]|$)/i,null],["lang-css-kw",/^(-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*)\s*:/i],["com",/^\/\*[^*]*\*+(?:[^*/][^*]*\*+)*\//],["com",
|
||||
/^(?:<\!--|--\>)/],["lit",/^(?:\d+|\d*\.\d+)(?:%|[a-z]+)?/i],["lit",/^#[\da-f]{3,6}/i],["pln",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i],["pun",/^[^\s\w"']+/]]),["css"]);PR.registerLangHandler(PR.createSimpleLexer([],[["kwd",/^-?(?:[_a-z]|\\[\da-f]+ ?)(?:[\w-]|\\\\[\da-f]+ ?)*/i]]),["css-kw"]);PR.registerLangHandler(PR.createSimpleLexer([],[["str",/^[^"')]+/]]),["css-str"]);
|
||||
28
docs/scripts/prettify/prettify.js
Normal file
@@ -0,0 +1,28 @@
|
||||
var q=null;window.PR_SHOULD_USE_CONTINUATION=!0;
|
||||
(function(){function L(a){function m(a){var f=a.charCodeAt(0);if(f!==92)return f;var b=a.charAt(1);return(f=r[b])?f:"0"<=b&&b<="7"?parseInt(a.substring(1),8):b==="u"||b==="x"?parseInt(a.substring(2),16):a.charCodeAt(1)}function e(a){if(a<32)return(a<16?"\\x0":"\\x")+a.toString(16);a=String.fromCharCode(a);if(a==="\\"||a==="-"||a==="["||a==="]")a="\\"+a;return a}function h(a){for(var f=a.substring(1,a.length-1).match(/\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\[0-3][0-7]{0,2}|\\[0-7]{1,2}|\\[\S\s]|[^\\]/g),a=
|
||||
[],b=[],o=f[0]==="^",c=o?1:0,i=f.length;c<i;++c){var j=f[c];if(/\\[bdsw]/i.test(j))a.push(j);else{var j=m(j),d;c+2<i&&"-"===f[c+1]?(d=m(f[c+2]),c+=2):d=j;b.push([j,d]);d<65||j>122||(d<65||j>90||b.push([Math.max(65,j)|32,Math.min(d,90)|32]),d<97||j>122||b.push([Math.max(97,j)&-33,Math.min(d,122)&-33]))}}b.sort(function(a,f){return a[0]-f[0]||f[1]-a[1]});f=[];j=[NaN,NaN];for(c=0;c<b.length;++c)i=b[c],i[0]<=j[1]+1?j[1]=Math.max(j[1],i[1]):f.push(j=i);b=["["];o&&b.push("^");b.push.apply(b,a);for(c=0;c<
|
||||
f.length;++c)i=f[c],b.push(e(i[0])),i[1]>i[0]&&(i[1]+1>i[0]&&b.push("-"),b.push(e(i[1])));b.push("]");return b.join("")}function y(a){for(var f=a.source.match(/\[(?:[^\\\]]|\\[\S\s])*]|\\u[\dA-Fa-f]{4}|\\x[\dA-Fa-f]{2}|\\\d+|\\[^\dux]|\(\?[!:=]|[()^]|[^()[\\^]+/g),b=f.length,d=[],c=0,i=0;c<b;++c){var j=f[c];j==="("?++i:"\\"===j.charAt(0)&&(j=+j.substring(1))&&j<=i&&(d[j]=-1)}for(c=1;c<d.length;++c)-1===d[c]&&(d[c]=++t);for(i=c=0;c<b;++c)j=f[c],j==="("?(++i,d[i]===void 0&&(f[c]="(?:")):"\\"===j.charAt(0)&&
|
||||
(j=+j.substring(1))&&j<=i&&(f[c]="\\"+d[i]);for(i=c=0;c<b;++c)"^"===f[c]&&"^"!==f[c+1]&&(f[c]="");if(a.ignoreCase&&s)for(c=0;c<b;++c)j=f[c],a=j.charAt(0),j.length>=2&&a==="["?f[c]=h(j):a!=="\\"&&(f[c]=j.replace(/[A-Za-z]/g,function(a){a=a.charCodeAt(0);return"["+String.fromCharCode(a&-33,a|32)+"]"}));return f.join("")}for(var t=0,s=!1,l=!1,p=0,d=a.length;p<d;++p){var g=a[p];if(g.ignoreCase)l=!0;else if(/[a-z]/i.test(g.source.replace(/\\u[\da-f]{4}|\\x[\da-f]{2}|\\[^UXux]/gi,""))){s=!0;l=!1;break}}for(var r=
|
||||
{b:8,t:9,n:10,v:11,f:12,r:13},n=[],p=0,d=a.length;p<d;++p){g=a[p];if(g.global||g.multiline)throw Error(""+g);n.push("(?:"+y(g)+")")}return RegExp(n.join("|"),l?"gi":"g")}function M(a){function m(a){switch(a.nodeType){case 1:if(e.test(a.className))break;for(var g=a.firstChild;g;g=g.nextSibling)m(g);g=a.nodeName;if("BR"===g||"LI"===g)h[s]="\n",t[s<<1]=y++,t[s++<<1|1]=a;break;case 3:case 4:g=a.nodeValue,g.length&&(g=p?g.replace(/\r\n?/g,"\n"):g.replace(/[\t\n\r ]+/g," "),h[s]=g,t[s<<1]=y,y+=g.length,
|
||||
t[s++<<1|1]=a)}}var e=/(?:^|\s)nocode(?:\s|$)/,h=[],y=0,t=[],s=0,l;a.currentStyle?l=a.currentStyle.whiteSpace:window.getComputedStyle&&(l=document.defaultView.getComputedStyle(a,q).getPropertyValue("white-space"));var p=l&&"pre"===l.substring(0,3);m(a);return{a:h.join("").replace(/\n$/,""),c:t}}function B(a,m,e,h){m&&(a={a:m,d:a},e(a),h.push.apply(h,a.e))}function x(a,m){function e(a){for(var l=a.d,p=[l,"pln"],d=0,g=a.a.match(y)||[],r={},n=0,z=g.length;n<z;++n){var f=g[n],b=r[f],o=void 0,c;if(typeof b===
|
||||
"string")c=!1;else{var i=h[f.charAt(0)];if(i)o=f.match(i[1]),b=i[0];else{for(c=0;c<t;++c)if(i=m[c],o=f.match(i[1])){b=i[0];break}o||(b="pln")}if((c=b.length>=5&&"lang-"===b.substring(0,5))&&!(o&&typeof o[1]==="string"))c=!1,b="src";c||(r[f]=b)}i=d;d+=f.length;if(c){c=o[1];var j=f.indexOf(c),k=j+c.length;o[2]&&(k=f.length-o[2].length,j=k-c.length);b=b.substring(5);B(l+i,f.substring(0,j),e,p);B(l+i+j,c,C(b,c),p);B(l+i+k,f.substring(k),e,p)}else p.push(l+i,b)}a.e=p}var h={},y;(function(){for(var e=a.concat(m),
|
||||
l=[],p={},d=0,g=e.length;d<g;++d){var r=e[d],n=r[3];if(n)for(var k=n.length;--k>=0;)h[n.charAt(k)]=r;r=r[1];n=""+r;p.hasOwnProperty(n)||(l.push(r),p[n]=q)}l.push(/[\S\s]/);y=L(l)})();var t=m.length;return e}function u(a){var m=[],e=[];a.tripleQuotedStrings?m.push(["str",/^(?:'''(?:[^'\\]|\\[\S\s]|''?(?=[^']))*(?:'''|$)|"""(?:[^"\\]|\\[\S\s]|""?(?=[^"]))*(?:"""|$)|'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$))/,q,"'\""]):a.multiLineStrings?m.push(["str",/^(?:'(?:[^'\\]|\\[\S\s])*(?:'|$)|"(?:[^"\\]|\\[\S\s])*(?:"|$)|`(?:[^\\`]|\\[\S\s])*(?:`|$))/,
|
||||
q,"'\"`"]):m.push(["str",/^(?:'(?:[^\n\r'\\]|\\.)*(?:'|$)|"(?:[^\n\r"\\]|\\.)*(?:"|$))/,q,"\"'"]);a.verbatimStrings&&e.push(["str",/^@"(?:[^"]|"")*(?:"|$)/,q]);var h=a.hashComments;h&&(a.cStyleComments?(h>1?m.push(["com",/^#(?:##(?:[^#]|#(?!##))*(?:###|$)|.*)/,q,"#"]):m.push(["com",/^#(?:(?:define|elif|else|endif|error|ifdef|include|ifndef|line|pragma|undef|warning)\b|[^\n\r]*)/,q,"#"]),e.push(["str",/^<(?:(?:(?:\.\.\/)*|\/?)(?:[\w-]+(?:\/[\w-]+)+)?[\w-]+\.h|[a-z]\w*)>/,q])):m.push(["com",/^#[^\n\r]*/,
|
||||
q,"#"]));a.cStyleComments&&(e.push(["com",/^\/\/[^\n\r]*/,q]),e.push(["com",/^\/\*[\S\s]*?(?:\*\/|$)/,q]));a.regexLiterals&&e.push(["lang-regex",/^(?:^^\.?|[!+-]|!=|!==|#|%|%=|&|&&|&&=|&=|\(|\*|\*=|\+=|,|-=|->|\/|\/=|:|::|;|<|<<|<<=|<=|=|==|===|>|>=|>>|>>=|>>>|>>>=|[?@[^]|\^=|\^\^|\^\^=|{|\||\|=|\|\||\|\|=|~|break|case|continue|delete|do|else|finally|instanceof|return|throw|try|typeof)\s*(\/(?=[^*/])(?:[^/[\\]|\\[\S\s]|\[(?:[^\\\]]|\\[\S\s])*(?:]|$))+\/)/]);(h=a.types)&&e.push(["typ",h]);a=(""+a.keywords).replace(/^ | $/g,
|
||||
"");a.length&&e.push(["kwd",RegExp("^(?:"+a.replace(/[\s,]+/g,"|")+")\\b"),q]);m.push(["pln",/^\s+/,q," \r\n\t\xa0"]);e.push(["lit",/^@[$_a-z][\w$@]*/i,q],["typ",/^(?:[@_]?[A-Z]+[a-z][\w$@]*|\w+_t\b)/,q],["pln",/^[$_a-z][\w$@]*/i,q],["lit",/^(?:0x[\da-f]+|(?:\d(?:_\d+)*\d*(?:\.\d*)?|\.\d\+)(?:e[+-]?\d+)?)[a-z]*/i,q,"0123456789"],["pln",/^\\[\S\s]?/,q],["pun",/^.[^\s\w"-$'./@\\`]*/,q]);return x(m,e)}function D(a,m){function e(a){switch(a.nodeType){case 1:if(k.test(a.className))break;if("BR"===a.nodeName)h(a),
|
||||
a.parentNode&&a.parentNode.removeChild(a);else for(a=a.firstChild;a;a=a.nextSibling)e(a);break;case 3:case 4:if(p){var b=a.nodeValue,d=b.match(t);if(d){var c=b.substring(0,d.index);a.nodeValue=c;(b=b.substring(d.index+d[0].length))&&a.parentNode.insertBefore(s.createTextNode(b),a.nextSibling);h(a);c||a.parentNode.removeChild(a)}}}}function h(a){function b(a,d){var e=d?a.cloneNode(!1):a,f=a.parentNode;if(f){var f=b(f,1),g=a.nextSibling;f.appendChild(e);for(var h=g;h;h=g)g=h.nextSibling,f.appendChild(h)}return e}
|
||||
for(;!a.nextSibling;)if(a=a.parentNode,!a)return;for(var a=b(a.nextSibling,0),e;(e=a.parentNode)&&e.nodeType===1;)a=e;d.push(a)}var k=/(?:^|\s)nocode(?:\s|$)/,t=/\r\n?|\n/,s=a.ownerDocument,l;a.currentStyle?l=a.currentStyle.whiteSpace:window.getComputedStyle&&(l=s.defaultView.getComputedStyle(a,q).getPropertyValue("white-space"));var p=l&&"pre"===l.substring(0,3);for(l=s.createElement("LI");a.firstChild;)l.appendChild(a.firstChild);for(var d=[l],g=0;g<d.length;++g)e(d[g]);m===(m|0)&&d[0].setAttribute("value",
|
||||
m);var r=s.createElement("OL");r.className="linenums";for(var n=Math.max(0,m-1|0)||0,g=0,z=d.length;g<z;++g)l=d[g],l.className="L"+(g+n)%10,l.firstChild||l.appendChild(s.createTextNode("\xa0")),r.appendChild(l);a.appendChild(r)}function k(a,m){for(var e=m.length;--e>=0;){var h=m[e];A.hasOwnProperty(h)?window.console&&console.warn("cannot override language handler %s",h):A[h]=a}}function C(a,m){if(!a||!A.hasOwnProperty(a))a=/^\s*</.test(m)?"default-markup":"default-code";return A[a]}function E(a){var m=
|
||||
a.g;try{var e=M(a.h),h=e.a;a.a=h;a.c=e.c;a.d=0;C(m,h)(a);var k=/\bMSIE\b/.test(navigator.userAgent),m=/\n/g,t=a.a,s=t.length,e=0,l=a.c,p=l.length,h=0,d=a.e,g=d.length,a=0;d[g]=s;var r,n;for(n=r=0;n<g;)d[n]!==d[n+2]?(d[r++]=d[n++],d[r++]=d[n++]):n+=2;g=r;for(n=r=0;n<g;){for(var z=d[n],f=d[n+1],b=n+2;b+2<=g&&d[b+1]===f;)b+=2;d[r++]=z;d[r++]=f;n=b}for(d.length=r;h<p;){var o=l[h+2]||s,c=d[a+2]||s,b=Math.min(o,c),i=l[h+1],j;if(i.nodeType!==1&&(j=t.substring(e,b))){k&&(j=j.replace(m,"\r"));i.nodeValue=
|
||||
j;var u=i.ownerDocument,v=u.createElement("SPAN");v.className=d[a+1];var x=i.parentNode;x.replaceChild(v,i);v.appendChild(i);e<o&&(l[h+1]=i=u.createTextNode(t.substring(b,o)),x.insertBefore(i,v.nextSibling))}e=b;e>=o&&(h+=2);e>=c&&(a+=2)}}catch(w){"console"in window&&console.log(w&&w.stack?w.stack:w)}}var v=["break,continue,do,else,for,if,return,while"],w=[[v,"auto,case,char,const,default,double,enum,extern,float,goto,int,long,register,short,signed,sizeof,static,struct,switch,typedef,union,unsigned,void,volatile"],
|
||||
"catch,class,delete,false,import,new,operator,private,protected,public,this,throw,true,try,typeof"],F=[w,"alignof,align_union,asm,axiom,bool,concept,concept_map,const_cast,constexpr,decltype,dynamic_cast,explicit,export,friend,inline,late_check,mutable,namespace,nullptr,reinterpret_cast,static_assert,static_cast,template,typeid,typename,using,virtual,where"],G=[w,"abstract,boolean,byte,extends,final,finally,implements,import,instanceof,null,native,package,strictfp,super,synchronized,throws,transient"],
|
||||
H=[G,"as,base,by,checked,decimal,delegate,descending,dynamic,event,fixed,foreach,from,group,implicit,in,interface,internal,into,is,lock,object,out,override,orderby,params,partial,readonly,ref,sbyte,sealed,stackalloc,string,select,uint,ulong,unchecked,unsafe,ushort,var"],w=[w,"debugger,eval,export,function,get,null,set,undefined,var,with,Infinity,NaN"],I=[v,"and,as,assert,class,def,del,elif,except,exec,finally,from,global,import,in,is,lambda,nonlocal,not,or,pass,print,raise,try,with,yield,False,True,None"],
|
||||
J=[v,"alias,and,begin,case,class,def,defined,elsif,end,ensure,false,in,module,next,nil,not,or,redo,rescue,retry,self,super,then,true,undef,unless,until,when,yield,BEGIN,END"],v=[v,"case,done,elif,esac,eval,fi,function,in,local,set,then,until"],K=/^(DIR|FILE|vector|(de|priority_)?queue|list|stack|(const_)?iterator|(multi)?(set|map)|bitset|u?(int|float)\d*)/,N=/\S/,O=u({keywords:[F,H,w,"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END"+
|
||||
I,J,v],hashComments:!0,cStyleComments:!0,multiLineStrings:!0,regexLiterals:!0}),A={};k(O,["default-code"]);k(x([],[["pln",/^[^<?]+/],["dec",/^<!\w[^>]*(?:>|$)/],["com",/^<\!--[\S\s]*?(?:--\>|$)/],["lang-",/^<\?([\S\s]+?)(?:\?>|$)/],["lang-",/^<%([\S\s]+?)(?:%>|$)/],["pun",/^(?:<[%?]|[%?]>)/],["lang-",/^<xmp\b[^>]*>([\S\s]+?)<\/xmp\b[^>]*>/i],["lang-js",/^<script\b[^>]*>([\S\s]*?)(<\/script\b[^>]*>)/i],["lang-css",/^<style\b[^>]*>([\S\s]*?)(<\/style\b[^>]*>)/i],["lang-in.tag",/^(<\/?[a-z][^<>]*>)/i]]),
|
||||
["default-markup","htm","html","mxml","xhtml","xml","xsl"]);k(x([["pln",/^\s+/,q," \t\r\n"],["atv",/^(?:"[^"]*"?|'[^']*'?)/,q,"\"'"]],[["tag",/^^<\/?[a-z](?:[\w-.:]*\w)?|\/?>$/i],["atn",/^(?!style[\s=]|on)[a-z](?:[\w:-]*\w)?/i],["lang-uq.val",/^=\s*([^\s"'>]*(?:[^\s"'/>]|\/(?=\s)))/],["pun",/^[/<->]+/],["lang-js",/^on\w+\s*=\s*"([^"]+)"/i],["lang-js",/^on\w+\s*=\s*'([^']+)'/i],["lang-js",/^on\w+\s*=\s*([^\s"'>]+)/i],["lang-css",/^style\s*=\s*"([^"]+)"/i],["lang-css",/^style\s*=\s*'([^']+)'/i],["lang-css",
|
||||
/^style\s*=\s*([^\s"'>]+)/i]]),["in.tag"]);k(x([],[["atv",/^[\S\s]+/]]),["uq.val"]);k(u({keywords:F,hashComments:!0,cStyleComments:!0,types:K}),["c","cc","cpp","cxx","cyc","m"]);k(u({keywords:"null,true,false"}),["json"]);k(u({keywords:H,hashComments:!0,cStyleComments:!0,verbatimStrings:!0,types:K}),["cs"]);k(u({keywords:G,cStyleComments:!0}),["java"]);k(u({keywords:v,hashComments:!0,multiLineStrings:!0}),["bsh","csh","sh"]);k(u({keywords:I,hashComments:!0,multiLineStrings:!0,tripleQuotedStrings:!0}),
|
||||
["cv","py"]);k(u({keywords:"caller,delete,die,do,dump,elsif,eval,exit,foreach,for,goto,if,import,last,local,my,next,no,our,print,package,redo,require,sub,undef,unless,until,use,wantarray,while,BEGIN,END",hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["perl","pl","pm"]);k(u({keywords:J,hashComments:!0,multiLineStrings:!0,regexLiterals:!0}),["rb"]);k(u({keywords:w,cStyleComments:!0,regexLiterals:!0}),["js"]);k(u({keywords:"all,and,by,catch,class,else,extends,false,finally,for,if,in,is,isnt,loop,new,no,not,null,of,off,on,or,return,super,then,true,try,unless,until,when,while,yes",
|
||||
hashComments:3,cStyleComments:!0,multilineStrings:!0,tripleQuotedStrings:!0,regexLiterals:!0}),["coffee"]);k(x([],[["str",/^[\S\s]+/]]),["regex"]);window.prettyPrintOne=function(a,m,e){var h=document.createElement("PRE");h.innerHTML=a;e&&D(h,e);E({g:m,i:e,h:h});return h.innerHTML};window.prettyPrint=function(a){function m(){for(var e=window.PR_SHOULD_USE_CONTINUATION?l.now()+250:Infinity;p<h.length&&l.now()<e;p++){var n=h[p],k=n.className;if(k.indexOf("prettyprint")>=0){var k=k.match(g),f,b;if(b=
|
||||
!k){b=n;for(var o=void 0,c=b.firstChild;c;c=c.nextSibling)var i=c.nodeType,o=i===1?o?b:c:i===3?N.test(c.nodeValue)?b:o:o;b=(f=o===b?void 0:o)&&"CODE"===f.tagName}b&&(k=f.className.match(g));k&&(k=k[1]);b=!1;for(o=n.parentNode;o;o=o.parentNode)if((o.tagName==="pre"||o.tagName==="code"||o.tagName==="xmp")&&o.className&&o.className.indexOf("prettyprint")>=0){b=!0;break}b||((b=(b=n.className.match(/\blinenums\b(?::(\d+))?/))?b[1]&&b[1].length?+b[1]:!0:!1)&&D(n,b),d={g:k,h:n,i:b},E(d))}}p<h.length?setTimeout(m,
|
||||
250):a&&a()}for(var e=[document.getElementsByTagName("pre"),document.getElementsByTagName("code"),document.getElementsByTagName("xmp")],h=[],k=0;k<e.length;++k)for(var t=0,s=e[k].length;t<s;++t)h.push(e[k][t]);var e=q,l=Date;l.now||(l={now:function(){return+new Date}});var p=0,d,g=/\blang(?:uage)?-([\w.]+)(?!\S)/;m()};window.PR={createSimpleLexer:x,registerLangHandler:k,sourceDecorator:u,PR_ATTRIB_NAME:"atn",PR_ATTRIB_VALUE:"atv",PR_COMMENT:"com",PR_DECLARATION:"dec",PR_KEYWORD:"kwd",PR_LITERAL:"lit",
|
||||
PR_NOCODE:"nocode",PR_PLAIN:"pln",PR_PUNCTUATION:"pun",PR_SOURCE:"src",PR_STRING:"str",PR_TAG:"tag",PR_TYPE:"typ"}})();
|
||||
692
docs/styles/jsdoc-default.css
Normal file
@@ -0,0 +1,692 @@
|
||||
@import url(https://fonts.googleapis.com/css?family=Source+Sans+Pro:300,400,400i,500i,500,600,600i|Roboto);
|
||||
|
||||
* {
|
||||
box-sizing: border-box
|
||||
}
|
||||
|
||||
html, body {
|
||||
height: 100%;
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
body {
|
||||
color: #4d4e53;
|
||||
background-color: white;
|
||||
margin: 0 auto;
|
||||
padding: 0;
|
||||
font-family: 'Source Sans Pro', Helvetica, sans-serif;
|
||||
font-size: 16px;
|
||||
line-height: 160%;
|
||||
}
|
||||
|
||||
a,
|
||||
a:active {
|
||||
color: #0095dd;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
a:hover {
|
||||
text-decoration: underline
|
||||
}
|
||||
|
||||
p, ul, ol, blockquote {
|
||||
margin-bottom: 1em;
|
||||
}
|
||||
|
||||
h1, h2, h3, h4, h5, h6 {
|
||||
font-family: 'Roboto', sans-serif;
|
||||
}
|
||||
|
||||
h1, h2, h3, h4, h5, h6 {
|
||||
color: #000;
|
||||
font-weight: 400;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
h1 {
|
||||
font-weight: 300;
|
||||
font-size: 48px;
|
||||
margin: 1em 0 .5em;
|
||||
}
|
||||
|
||||
h1.page-title {margin-bottom: 10px;font-size: 34px;font-weight: 300;border-bottom: solid 2px #ddd;padding: .5em 0 .5em;margin-top: 0;}
|
||||
|
||||
h2 {
|
||||
font-size: 32px;
|
||||
margin: 1.2em 0 .8em;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
h3 {
|
||||
/* margin-top: 1em; */
|
||||
/* margin-bottom: 16px; */
|
||||
/* font-weight: bold; */
|
||||
padding: 0;
|
||||
margin: 1em 0 .6em;
|
||||
font-size: 28px;
|
||||
/* border-bottom: 1px solid #eee; */
|
||||
/* padding-bottom: 15px; */
|
||||
}
|
||||
|
||||
h4 {
|
||||
font-size: 18px;
|
||||
margin: 1em 0 .2em;
|
||||
color: #4d4e53;
|
||||
/* border-bottom: 1px solid #eee; */
|
||||
padding-bottom: 8px;
|
||||
}
|
||||
|
||||
h5, .container-overview .subsection-title {
|
||||
font-size: 120%;
|
||||
/* letter-spacing: -0.01em; */
|
||||
margin: 20px 0 5px;
|
||||
}
|
||||
|
||||
h6 {
|
||||
font-size: 100%;
|
||||
letter-spacing: -0.01em;
|
||||
margin: 6px 0 3px 0;
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
tt, code, kbd, samp {
|
||||
font-family: Consolas, Monaco, 'Andale Mono', monospace;
|
||||
background: #f4f4f4;
|
||||
padding: 1px 5px;
|
||||
border-radius: 5px;
|
||||
font-size: 14px;
|
||||
}
|
||||
|
||||
blockquote {
|
||||
display: block;
|
||||
border-left: 4px solid #eee;
|
||||
margin: 0;
|
||||
padding-left: 1em;
|
||||
color: #888;
|
||||
}
|
||||
|
||||
.class-description {
|
||||
font-size: 130%;
|
||||
line-height: 140%;
|
||||
margin-bottom: 1em;
|
||||
margin-top: 1em;
|
||||
}
|
||||
|
||||
.class-description:empty {
|
||||
margin: 0
|
||||
}
|
||||
|
||||
/** Container **/
|
||||
#main {
|
||||
float: right;
|
||||
min-width: 360px;
|
||||
width: calc(100% - 250px);
|
||||
padding: 0 30px 20px 30px;
|
||||
}
|
||||
|
||||
header {
|
||||
display: block
|
||||
}
|
||||
|
||||
section {
|
||||
display: block;
|
||||
background-color: #fff;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
.variation {
|
||||
display: none
|
||||
}
|
||||
|
||||
.signature-attributes {
|
||||
font-size: 60%;
|
||||
color: #aaa;
|
||||
font-style: italic;
|
||||
font-weight: lighter;
|
||||
}
|
||||
|
||||
/** Readme **/
|
||||
|
||||
.readme {
|
||||
font-size: 16px;
|
||||
}
|
||||
|
||||
.readme h1,
|
||||
.readme h2,
|
||||
.readme h3,
|
||||
.readme h4,
|
||||
.readme h5 {
|
||||
margin-top: 1em;
|
||||
margin-bottom: 16px;
|
||||
font-weight: bold;
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
.readme h1 {
|
||||
font-size: 2em;
|
||||
padding-bottom: 0.3em;
|
||||
}
|
||||
|
||||
.readme h2 {
|
||||
font-size: 1.75em;
|
||||
padding-bottom: 0.3em;
|
||||
}
|
||||
|
||||
.readme h3 {
|
||||
font-size: 1.5em;
|
||||
background-color: transparent;
|
||||
}
|
||||
|
||||
.readme h4 {
|
||||
font-size: 1.25em;
|
||||
}
|
||||
|
||||
.readme h5 {
|
||||
font-size: 1em;
|
||||
}
|
||||
|
||||
.readme img {
|
||||
max-width: 100%;
|
||||
}
|
||||
|
||||
.readme ul, .readme ol {
|
||||
padding-left: 2em;
|
||||
}
|
||||
|
||||
.readme pre > code {
|
||||
font-size: 0.85em;
|
||||
}
|
||||
|
||||
.readme table {
|
||||
margin-bottom: 1em;
|
||||
border-collapse: collapse;
|
||||
border-spacing: 0;
|
||||
}
|
||||
|
||||
.readme table tr {
|
||||
background-color: #fff;
|
||||
border-top: 1px solid #ccc;
|
||||
}
|
||||
|
||||
.readme table th,
|
||||
.readme table td {
|
||||
padding: 6px 13px;
|
||||
border: 1px solid #ddd;
|
||||
}
|
||||
|
||||
.readme table tr:nth-child(2n) {
|
||||
background-color: #f8f8f8;
|
||||
}
|
||||
|
||||
/** Nav **/
|
||||
nav {
|
||||
float: left;
|
||||
display: block;
|
||||
width: 250px;
|
||||
background: #fff;
|
||||
overflow: auto;
|
||||
position: fixed;
|
||||
height: 100%;
|
||||
padding: 10px;
|
||||
border-right: 1px solid #eee;
|
||||
/* box-shadow: 0 0 3px rgba(0,0,0,0.1); */
|
||||
}
|
||||
|
||||
nav li {
|
||||
list-style: none;
|
||||
padding: 0;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
.nav-heading {
|
||||
margin-top: 10px;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
.nav-heading a {
|
||||
color: #888;
|
||||
font-size: 14px;
|
||||
display: inline-block;
|
||||
}
|
||||
|
||||
.nav-item-type {
|
||||
/* margin-left: 5px; */
|
||||
width: 18px;
|
||||
height: 18px;
|
||||
display: inline-block;
|
||||
text-align: center;
|
||||
border-radius: 0.2em;
|
||||
margin-right: 5px;
|
||||
font-weight: bold;
|
||||
line-height: 20px;
|
||||
font-size: 13px;
|
||||
}
|
||||
|
||||
.type-function {
|
||||
background: #B3E5FC;
|
||||
color: #0288D1;
|
||||
}
|
||||
|
||||
.type-class {
|
||||
background: #D1C4E9;
|
||||
color: #4527A0;
|
||||
}
|
||||
|
||||
.type-member {
|
||||
background: #C8E6C9;
|
||||
color: #388E3C;
|
||||
}
|
||||
|
||||
.type-module {
|
||||
background: #E1BEE7;
|
||||
color: #7B1FA2;
|
||||
}
|
||||
|
||||
|
||||
/** Footer **/
|
||||
footer {
|
||||
color: hsl(0, 0%, 28%);
|
||||
margin-left: 250px;
|
||||
display: block;
|
||||
padding: 30px;
|
||||
font-style: italic;
|
||||
font-size: 90%;
|
||||
border-top: 1px solid #eee;
|
||||
}
|
||||
|
||||
.ancestors {
|
||||
color: #999
|
||||
}
|
||||
|
||||
.ancestors a {
|
||||
color: #999 !important;
|
||||
text-decoration: none;
|
||||
}
|
||||
|
||||
.clear {
|
||||
clear: both
|
||||
}
|
||||
|
||||
.important {
|
||||
font-weight: bold;
|
||||
color: #950B02;
|
||||
}
|
||||
|
||||
.yes-def {
|
||||
text-indent: -1000px
|
||||
}
|
||||
|
||||
.type-signature {
|
||||
color: #aaa
|
||||
}
|
||||
|
||||
.name, .signature {
|
||||
font-family: Consolas, Monaco, 'Andale Mono', monospace
|
||||
}
|
||||
|
||||
.details {
|
||||
margin-top: 14px;
|
||||
border-left: 2px solid #DDD;
|
||||
line-height: 30px;
|
||||
}
|
||||
|
||||
.details dt {
|
||||
width: 120px;
|
||||
float: left;
|
||||
padding-left: 10px;
|
||||
}
|
||||
|
||||
.details dd {
|
||||
margin-left: 70px
|
||||
}
|
||||
|
||||
.details ul {
|
||||
margin: 0
|
||||
}
|
||||
|
||||
.details ul {
|
||||
list-style-type: none
|
||||
}
|
||||
|
||||
.details li {
|
||||
margin-left: 30px
|
||||
}
|
||||
|
||||
.details pre.prettyprint {
|
||||
margin: 0
|
||||
}
|
||||
|
||||
.details .object-value {
|
||||
padding-top: 0
|
||||
}
|
||||
|
||||
.description {
|
||||
margin-bottom: 1em;
|
||||
margin-top: 1em;
|
||||
}
|
||||
|
||||
.code-caption {
|
||||
font-style: italic;
|
||||
font-size: 107%;
|
||||
margin: 0;
|
||||
}
|
||||
|
||||
.prettyprint {
|
||||
font-size: 13px;
|
||||
border: 1px solid #ddd;
|
||||
border-radius: 3px;
|
||||
box-shadow: 0 1px 3px hsla(0, 0%, 0%, 0.05);
|
||||
overflow: auto;
|
||||
}
|
||||
|
||||
.prettyprint.source {
|
||||
width: inherit
|
||||
}
|
||||
|
||||
.prettyprint code {
|
||||
font-size: 12px;
|
||||
line-height: 18px;
|
||||
display: block;
|
||||
background-color: #fff;
|
||||
color: #4D4E53;
|
||||
}
|
||||
|
||||
.prettyprint code:empty:before {
|
||||
content: '';
|
||||
}
|
||||
|
||||
.prettyprint > code {
|
||||
padding: 15px
|
||||
}
|
||||
|
||||
.prettyprint .linenums code {
|
||||
padding: 0 15px
|
||||
}
|
||||
|
||||
.prettyprint .linenums li:first-of-type code {
|
||||
padding-top: 15px
|
||||
}
|
||||
|
||||
.prettyprint code span.line {
|
||||
display: inline-block
|
||||
}
|
||||
|
||||
.prettyprint.linenums {
|
||||
padding-left: 70px;
|
||||
-webkit-user-select: none;
|
||||
-moz-user-select: none;
|
||||
-ms-user-select: none;
|
||||
user-select: none;
|
||||
}
|
||||
|
||||
.prettyprint.linenums ol {
|
||||
padding-left: 0
|
||||
}
|
||||
|
||||
.prettyprint.linenums li {
|
||||
border-left: 3px #ddd solid
|
||||
}
|
||||
|
||||
.prettyprint.linenums li.selected, .prettyprint.linenums li.selected * {
|
||||
background-color: lightyellow
|
||||
}
|
||||
|
||||
.prettyprint.linenums li * {
|
||||
-webkit-user-select: text;
|
||||
-moz-user-select: text;
|
||||
-ms-user-select: text;
|
||||
user-select: text;
|
||||
}
|
||||
|
||||
.params, .props {
|
||||
border-spacing: 0;
|
||||
border: 1px solid #ddd;
|
||||
border-collapse: collapse;
|
||||
border-radius: 3px;
|
||||
box-shadow: 0 1px 3px rgba(0,0,0,0.1);
|
||||
width: 100%;
|
||||
font-size: 14px;
|
||||
/* margin-left: 15px; */
|
||||
}
|
||||
|
||||
.params .name, .props .name, .name code {
|
||||
color: #4D4E53;
|
||||
font-family: Consolas, Monaco, 'Andale Mono', monospace;
|
||||
font-size: 100%;
|
||||
}
|
||||
|
||||
.params td, .params th, .props td, .props th {
|
||||
margin: 0px;
|
||||
text-align: left;
|
||||
vertical-align: top;
|
||||
padding: 10px;
|
||||
display: table-cell;
|
||||
}
|
||||
|
||||
.params td {
|
||||
border-top: 1px solid #eee
|
||||
}
|
||||
|
||||
.params thead tr, .props thead tr {
|
||||
background-color: #fff;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
.params .params thead tr, .props .props thead tr {
|
||||
background-color: #fff;
|
||||
font-weight: bold;
|
||||
}
|
||||
|
||||
.params td.description > p:first-child, .props td.description > p:first-child {
|
||||
margin-top: 0;
|
||||
padding-top: 0;
|
||||
}
|
||||
|
||||
.params td.description > p:last-child, .props td.description > p:last-child {
|
||||
margin-bottom: 0;
|
||||
padding-bottom: 0;
|
||||
}
|
||||
|
||||
dl.param-type {
|
||||
/* border-bottom: 1px solid hsl(0, 0%, 87%); */
|
||||
margin: 0;
|
||||
padding: 0;
|
||||
font-size: 16px;
|
||||
}
|
||||
|
||||
.param-type dt, .param-type dd {
|
||||
display: inline-block
|
||||
}
|
||||
|
||||
.param-type dd {
|
||||
font-family: Consolas, Monaco, 'Andale Mono', monospace;
|
||||
display: inline-block;
|
||||
padding: 0;
|
||||
margin: 0;
|
||||
font-size: 14px;
|
||||
}
|
||||
|
||||
.disabled {
|
||||
color: #454545
|
||||
}
|
||||
|
||||
/* navicon button */
|
||||
.navicon-button {
|
||||
display: none;
|
||||
position: relative;
|
||||
padding: 2.0625rem 1.5rem;
|
||||
transition: 0.25s;
|
||||
cursor: pointer;
|
||||
user-select: none;
|
||||
opacity: .8;
|
||||
}
|
||||
.navicon-button .navicon:before, .navicon-button .navicon:after {
|
||||
transition: 0.25s;
|
||||
}
|
||||
.navicon-button:hover {
|
||||
transition: 0.5s;
|
||||
opacity: 1;
|
||||
}
|
||||
.navicon-button:hover .navicon:before, .navicon-button:hover .navicon:after {
|
||||
transition: 0.25s;
|
||||
}
|
||||
.navicon-button:hover .navicon:before {
|
||||
top: .825rem;
|
||||
}
|
||||
.navicon-button:hover .navicon:after {
|
||||
top: -.825rem;
|
||||
}
|
||||
|
||||
/* navicon */
|
||||
.navicon {
|
||||
position: relative;
|
||||
width: 2.5em;
|
||||
height: .3125rem;
|
||||
background: #000;
|
||||
transition: 0.3s;
|
||||
border-radius: 2.5rem;
|
||||
}
|
||||
.navicon:before, .navicon:after {
|
||||
display: block;
|
||||
content: "";
|
||||
height: .3125rem;
|
||||
width: 2.5rem;
|
||||
background: #000;
|
||||
position: absolute;
|
||||
z-index: -1;
|
||||
transition: 0.3s 0.25s;
|
||||
border-radius: 1rem;
|
||||
}
|
||||
.navicon:before {
|
||||
top: .625rem;
|
||||
}
|
||||
.navicon:after {
|
||||
top: -.625rem;
|
||||
}
|
||||
|
||||
/* open */
|
||||
.nav-trigger:checked + label:not(.steps) .navicon:before,
|
||||
.nav-trigger:checked + label:not(.steps) .navicon:after {
|
||||
top: 0 !important;
|
||||
}
|
||||
|
||||
.nav-trigger:checked + label .navicon:before,
|
||||
.nav-trigger:checked + label .navicon:after {
|
||||
transition: 0.5s;
|
||||
}
|
||||
|
||||
/* Minus */
|
||||
.nav-trigger:checked + label {
|
||||
transform: scale(0.75);
|
||||
}
|
||||
|
||||
/* Ã and + */
|
||||
.nav-trigger:checked + label.plus .navicon,
|
||||
.nav-trigger:checked + label.x .navicon {
|
||||
background: transparent;
|
||||
}
|
||||
|
||||
.nav-trigger:checked + label.plus .navicon:before,
|
||||
.nav-trigger:checked + label.x .navicon:before {
|
||||
transform: rotate(-45deg);
|
||||
background: #FFF;
|
||||
}
|
||||
|
||||
.nav-trigger:checked + label.plus .navicon:after,
|
||||
.nav-trigger:checked + label.x .navicon:after {
|
||||
transform: rotate(45deg);
|
||||
background: #FFF;
|
||||
}
|
||||
|
||||
.nav-trigger:checked + label.plus {
|
||||
transform: scale(0.75) rotate(45deg);
|
||||
}
|
||||
|
||||
.nav-trigger:checked ~ nav {
|
||||
left: 0 !important;
|
||||
}
|
||||
|
||||
.nav-trigger:checked ~ .overlay {
|
||||
display: block;
|
||||
}
|
||||
|
||||
.nav-trigger {
|
||||
position: fixed;
|
||||
top: 0;
|
||||
clip: rect(0, 0, 0, 0);
|
||||
}
|
||||
|
||||
.overlay {
|
||||
display: none;
|
||||
position: fixed;
|
||||
top: 0;
|
||||
bottom: 0;
|
||||
left: 0;
|
||||
right: 0;
|
||||
width: 100%;
|
||||
height: 100%;
|
||||
background: hsla(0, 0%, 0%, 0.5);
|
||||
z-index: 1;
|
||||
}
|
||||
|
||||
.section-method {
|
||||
margin-bottom: 30px;
|
||||
padding-bottom: 30px;
|
||||
border-bottom: 1px solid #eee;
|
||||
}
|
||||
|
||||
@media only screen and (min-width: 320px) and (max-width: 680px) {
|
||||
body {
|
||||
overflow-x: hidden;
|
||||
}
|
||||
|
||||
nav {
|
||||
background: #FFF;
|
||||
width: 250px;
|
||||
height: 100%;
|
||||
position: fixed;
|
||||
top: 0;
|
||||
right: 0;
|
||||
bottom: 0;
|
||||
left: -250px;
|
||||
z-index: 3;
|
||||
padding: 0 10px;
|
||||
transition: left 0.2s;
|
||||
}
|
||||
|
||||
.navicon-button {
|
||||
display: inline-block;
|
||||
position: fixed;
|
||||
top: 1.5em;
|
||||
right: 0;
|
||||
z-index: 2;
|
||||
}
|
||||
|
||||
#main {
|
||||
width: 100%;
|
||||
min-width: 360px;
|
||||
}
|
||||
|
||||
#main h1.page-title {
|
||||
margin: 1em 0;
|
||||
}
|
||||
|
||||
#main section {
|
||||
padding: 0;
|
||||
}
|
||||
|
||||
footer {
|
||||
margin-left: 0;
|
||||
}
|
||||
}
|
||||
|
||||
@media only print {
|
||||
nav {
|
||||
display: none;
|
||||
}
|
||||
|
||||
#main {
|
||||
float: none;
|
||||
width: 100%;
|
||||
}
|
||||
}
|
||||
111
docs/styles/prettify-jsdoc.css
Normal file
@@ -0,0 +1,111 @@
|
||||
/* JSDoc prettify.js theme */
|
||||
|
||||
/* plain text */
|
||||
.pln {
|
||||
color: #000000;
|
||||
font-weight: normal;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* string content */
|
||||
.str {
|
||||
color: hsl(104, 100%, 24%);
|
||||
font-weight: normal;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* a keyword */
|
||||
.kwd {
|
||||
color: #000000;
|
||||
font-weight: bold;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* a comment */
|
||||
.com {
|
||||
font-weight: normal;
|
||||
font-style: italic;
|
||||
}
|
||||
|
||||
/* a type name */
|
||||
.typ {
|
||||
color: #000000;
|
||||
font-weight: normal;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* a literal value */
|
||||
.lit {
|
||||
color: #006400;
|
||||
font-weight: normal;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* punctuation */
|
||||
.pun {
|
||||
color: #000000;
|
||||
font-weight: bold;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* lisp open bracket */
|
||||
.opn {
|
||||
color: #000000;
|
||||
font-weight: bold;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* lisp close bracket */
|
||||
.clo {
|
||||
color: #000000;
|
||||
font-weight: bold;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* a markup tag name */
|
||||
.tag {
|
||||
color: #006400;
|
||||
font-weight: normal;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* a markup attribute name */
|
||||
.atn {
|
||||
color: #006400;
|
||||
font-weight: normal;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* a markup attribute value */
|
||||
.atv {
|
||||
color: #006400;
|
||||
font-weight: normal;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* a declaration */
|
||||
.dec {
|
||||
color: #000000;
|
||||
font-weight: bold;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* a variable name */
|
||||
.var {
|
||||
color: #000000;
|
||||
font-weight: normal;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* a function name */
|
||||
.fun {
|
||||
color: #000000;
|
||||
font-weight: bold;
|
||||
font-style: normal;
|
||||
}
|
||||
|
||||
/* Specify class=linenums on a pre to get line numbering */
|
||||
ol.linenums {
|
||||
margin-top: 0;
|
||||
margin-bottom: 0;
|
||||
}
|
||||
132
docs/styles/prettify-tomorrow.css
Normal file
@@ -0,0 +1,132 @@
|
||||
/* Tomorrow Theme */
|
||||
/* Original theme - https://github.com/chriskempson/tomorrow-theme */
|
||||
/* Pretty printing styles. Used with prettify.js. */
|
||||
/* SPAN elements with the classes below are added by prettyprint. */
|
||||
/* plain text */
|
||||
.pln {
|
||||
color: #4d4d4c; }
|
||||
|
||||
@media screen {
|
||||
/* string content */
|
||||
.str {
|
||||
color: hsl(104, 100%, 24%); }
|
||||
|
||||
/* a keyword */
|
||||
.kwd {
|
||||
color: hsl(240, 100%, 50%); }
|
||||
|
||||
/* a comment */
|
||||
.com {
|
||||
color: hsl(0, 0%, 60%); }
|
||||
|
||||
/* a type name */
|
||||
.typ {
|
||||
color: hsl(240, 100%, 32%); }
|
||||
|
||||
/* a literal value */
|
||||
.lit {
|
||||
color: hsl(240, 100%, 40%); }
|
||||
|
||||
/* punctuation */
|
||||
.pun {
|
||||
color: #000000; }
|
||||
|
||||
/* lisp open bracket */
|
||||
.opn {
|
||||
color: #000000; }
|
||||
|
||||
/* lisp close bracket */
|
||||
.clo {
|
||||
color: #000000; }
|
||||
|
||||
/* a markup tag name */
|
||||
.tag {
|
||||
color: #c82829; }
|
||||
|
||||
/* a markup attribute name */
|
||||
.atn {
|
||||
color: #f5871f; }
|
||||
|
||||
/* a markup attribute value */
|
||||
.atv {
|
||||
color: #3e999f; }
|
||||
|
||||
/* a declaration */
|
||||
.dec {
|
||||
color: #f5871f; }
|
||||
|
||||
/* a variable name */
|
||||
.var {
|
||||
color: #c82829; }
|
||||
|
||||
/* a function name */
|
||||
.fun {
|
||||
color: #4271ae; } }
|
||||
/* Use higher contrast and text-weight for printable form. */
|
||||
@media print, projection {
|
||||
.str {
|
||||
color: #060; }
|
||||
|
||||
.kwd {
|
||||
color: #006;
|
||||
font-weight: bold; }
|
||||
|
||||
.com {
|
||||
color: #600;
|
||||
font-style: italic; }
|
||||
|
||||
.typ {
|
||||
color: #404;
|
||||
font-weight: bold; }
|
||||
|
||||
.lit {
|
||||
color: #044; }
|
||||
|
||||
.pun, .opn, .clo {
|
||||
color: #440; }
|
||||
|
||||
.tag {
|
||||
color: #006;
|
||||
font-weight: bold; }
|
||||
|
||||
.atn {
|
||||
color: #404; }
|
||||
|
||||
.atv {
|
||||
color: #060; } }
|
||||
/* Style */
|
||||
/*
|
||||
pre.prettyprint {
|
||||
background: white;
|
||||
font-family: Consolas, Monaco, 'Andale Mono', monospace;
|
||||
font-size: 12px;
|
||||
line-height: 1.5;
|
||||
border: 1px solid #ccc;
|
||||
padding: 10px; }
|
||||
*/
|
||||
|
||||
/* Specify class=linenums on a pre to get line numbering */
|
||||
ol.linenums {
|
||||
margin-top: 0;
|
||||
margin-bottom: 0; }
|
||||
|
||||
/* IE indents via margin-left */
|
||||
li.L0,
|
||||
li.L1,
|
||||
li.L2,
|
||||
li.L3,
|
||||
li.L4,
|
||||
li.L5,
|
||||
li.L6,
|
||||
li.L7,
|
||||
li.L8,
|
||||
li.L9 {
|
||||
/* */ }
|
||||
|
||||
/* Alternate shading for lines */
|
||||
li.L1,
|
||||
li.L3,
|
||||
li.L5,
|
||||
li.L7,
|
||||
li.L9 {
|
||||
/* */ }
|
||||
2
docs/template/.gitignore
vendored
Normal file
@@ -0,0 +1,2 @@
|
||||
out/
|
||||
.DS_STORE
|
||||
61
docs/template/LICENSE
vendored
Normal file
@@ -0,0 +1,61 @@
|
||||
# License
|
||||
|
||||
Minami is free software, licensed under the Apache License, Version 2.0 (the
|
||||
"License"). Commercial and non-commercial use are permitted in compliance with
|
||||
the License.
|
||||
|
||||
Copyright (c) 2014-2015 Nijiko Yonskai <nijikokun@gmail.com> and the
|
||||
[contributors to Minami](https://github.com/Nijikokun/minami/graphs/contributors).
|
||||
All rights reserved.
|
||||
|
||||
You may obtain a copy of the License at:
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
In addition, a copy of the License is included with this distribution.
|
||||
|
||||
As stated in Section 7, "Disclaimer of Warranty," of the License:
|
||||
|
||||
> Licensor provides the Work (and each Contributor provides its Contributions)
|
||||
> on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
|
||||
> express or implied, including, without limitation, any warranties or
|
||||
> conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
> PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
> appropriateness of using or redistributing the Work and assume any risks
|
||||
> associated with Your exercise of permissions under this License.
|
||||
|
||||
The source code for JSDoc 3 is available at:
|
||||
https://github.com/Nijikokun/minami
|
||||
|
||||
# Third-Party Software
|
||||
|
||||
Minami includes or depends upon the following third-party software, either in
|
||||
whole or in part. Each third-party software package is provided under its own
|
||||
license.
|
||||
|
||||
## JSDoc 3
|
||||
|
||||
JSDoc 3 is free software, licensed under the Apache License, Version 2.0 (the
|
||||
"License"). Commercial and non-commercial use are permitted in compliance with
|
||||
the License.
|
||||
|
||||
Copyright (c) 2011-2015 Michael Mathews <micmath@gmail.com> and the
|
||||
[contributors to JSDoc](https://github.com/jsdoc3/jsdoc/graphs/contributors).
|
||||
All rights reserved.
|
||||
|
||||
You may obtain a copy of the License at:
|
||||
http://www.apache.org/licenses/LICENSE-2.0
|
||||
|
||||
In addition, a copy of the License is included with this distribution.
|
||||
|
||||
As stated in Section 7, "Disclaimer of Warranty," of the License:
|
||||
|
||||
> Licensor provides the Work (and each Contributor provides its Contributions)
|
||||
> on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either
|
||||
> express or implied, including, without limitation, any warranties or
|
||||
> conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
||||
> PARTICULAR PURPOSE. You are solely responsible for determining the
|
||||
> appropriateness of using or redistributing the Work and assume any risks
|
||||
> associated with Your exercise of permissions under this License.
|
||||
|
||||
The source code for JSDoc 3 is available at:
|
||||
https://github.com/jsdoc3/jsdoc
|
||||
87
docs/template/README.md
vendored
Normal file
@@ -0,0 +1,87 @@
|
||||
# Minami
|
||||
|
||||
A clean, responsive documentation template theme for JSDoc 3.
|
||||
|
||||

|
||||
|
||||
|
||||
## Uses
|
||||
|
||||
- [the Taffy Database library](http://taffydb.com/)
|
||||
- [Underscore Template library](http://underscorejs.org/#template)
|
||||
- [Montserrat](https://fonts.google.com/specimen/Montserrat) & Helvetica Neue
|
||||
|
||||
|
||||
## Install
|
||||
|
||||
```bash
|
||||
$ npm install --save-dev minami
|
||||
```
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Clone repository to your designated `jsdoc` template directory, then:
|
||||
|
||||
```bash
|
||||
$ jsdoc entry-file.js -t path/to/minami
|
||||
```
|
||||
|
||||
|
||||
### Node.js Dependency
|
||||
|
||||
In your projects `package.json` file add a generate script:
|
||||
|
||||
```json
|
||||
"script": {
|
||||
"generate-docs": "node_modules/.bin/jsdoc --configure .jsdoc.json --verbose"
|
||||
}
|
||||
```
|
||||
|
||||
In your `.jsdoc.json` file, add a template option.
|
||||
|
||||
```json
|
||||
"opts": {
|
||||
"template": "node_modules/minami"
|
||||
}
|
||||
```
|
||||
|
||||
|
||||
### Example JSDoc Config
|
||||
|
||||
```json
|
||||
{
|
||||
"tags": {
|
||||
"allowUnknownTags": true,
|
||||
"dictionaries": ["jsdoc"]
|
||||
},
|
||||
"source": {
|
||||
"include": ["lib", "package.json", "README.md"],
|
||||
"includePattern": ".js$",
|
||||
"excludePattern": "(node_modules/|docs)"
|
||||
},
|
||||
"plugins": [
|
||||
"plugins/markdown"
|
||||
],
|
||||
"templates": {
|
||||
"cleverLinks": false,
|
||||
"monospaceLinks": true,
|
||||
"useLongnameInNav": false,
|
||||
"showInheritedInNav": true
|
||||
},
|
||||
"opts": {
|
||||
"destination": "./docs/",
|
||||
"encoding": "utf8",
|
||||
"private": true,
|
||||
"recurse": true,
|
||||
"template": "./node_modules/minami"
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
Specifying a number for useLongnameInNav it will be the max number of path elements to show in nav (starting from Class).
|
||||
|
||||
|
||||
## License
|
||||
|
||||
Licensed under the Apache2 license.
|
||||
24
docs/template/package.json
vendored
Normal file
@@ -0,0 +1,24 @@
|
||||
{
|
||||
"name": "minami",
|
||||
"version": "1.2.3",
|
||||
"description": "Clean and minimal JSDoc 3 Template / Theme",
|
||||
"main": "publish.js",
|
||||
"scripts": {
|
||||
"test": "echo \"Error: no test specified\" && exit 1"
|
||||
},
|
||||
"repository": {
|
||||
"type": "git",
|
||||
"url": "https://github.com/Nijikokun/minami.git"
|
||||
},
|
||||
"author": "Nijiko Yonskai <nijikokun@gmail.com>",
|
||||
"licenses": [
|
||||
{
|
||||
"type": "Apache-2.0",
|
||||
"url": "http://www.apache.org/licenses/LICENSE-2.0"
|
||||
}
|
||||
],
|
||||
"bugs": {
|
||||
"url": "https://github.com/Nijikokun/minami/issues"
|
||||
},
|
||||
"homepage": "https://github.com/Nijikokun/minami"
|
||||
}
|
||||
830
docs/template/publish.js
vendored
Normal file
@@ -0,0 +1,830 @@
|
||||
/*global env: true */
|
||||
"use strict"
|
||||
|
||||
var doop = require("jsdoc/util/doop")
|
||||
var fs = require("jsdoc/fs")
|
||||
var helper = require("jsdoc/util/templateHelper")
|
||||
var logger = require("jsdoc/util/logger")
|
||||
var path = require("jsdoc/path")
|
||||
var taffy = require("taffydb").taffy
|
||||
var template = require("jsdoc/template")
|
||||
var util = require("util")
|
||||
|
||||
var htmlsafe = helper.htmlsafe
|
||||
var linkto = helper.linkto
|
||||
var resolveAuthorLinks = helper.resolveAuthorLinks
|
||||
var scopeToPunc = helper.scopeToPunc
|
||||
var hasOwnProp = Object.prototype.hasOwnProperty
|
||||
|
||||
var data
|
||||
var view
|
||||
|
||||
var outdir = path.normalize(env.opts.destination)
|
||||
|
||||
function find(spec) {
|
||||
return helper.find(data, spec)
|
||||
}
|
||||
|
||||
function tutoriallink(tutorial) {
|
||||
return helper.toTutorial(tutorial, null, {
|
||||
tag: "em",
|
||||
classname: "disabled",
|
||||
prefix: "Tutorial: "
|
||||
})
|
||||
}
|
||||
|
||||
function getAncestorLinks(doclet) {
|
||||
return helper.getAncestorLinks(data, doclet)
|
||||
}
|
||||
|
||||
function hashToLink(doclet, hash) {
|
||||
if (!/^(#.+)/.test(hash)) {
|
||||
return hash
|
||||
}
|
||||
|
||||
var url = helper.createLink(doclet)
|
||||
|
||||
url = url.replace(/(#.+|$)/, hash)
|
||||
return '<a href="' + url + '">' + hash + "</a>"
|
||||
}
|
||||
|
||||
function needsSignature(doclet) {
|
||||
var needsSig = false
|
||||
|
||||
// function and class definitions always get a signature
|
||||
if (doclet.kind === "function" || doclet.kind === "class") {
|
||||
needsSig = true
|
||||
} else if (
|
||||
doclet.kind === "typedef" &&
|
||||
doclet.type &&
|
||||
doclet.type.names &&
|
||||
doclet.type.names.length
|
||||
) {
|
||||
// typedefs that contain functions get a signature, too
|
||||
for (var i = 0, l = doclet.type.names.length; i < l; i++) {
|
||||
if (doclet.type.names[i].toLowerCase() === "function") {
|
||||
needsSig = true
|
||||
break
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
return needsSig
|
||||
}
|
||||
|
||||
function getSignatureAttributes(item) {
|
||||
var attributes = []
|
||||
|
||||
if (item.optional) {
|
||||
attributes.push("opt")
|
||||
}
|
||||
|
||||
if (item.nullable === true) {
|
||||
attributes.push("nullable")
|
||||
} else if (item.nullable === false) {
|
||||
attributes.push("non-null")
|
||||
}
|
||||
|
||||
return attributes
|
||||
}
|
||||
|
||||
function updateItemName(item) {
|
||||
var attributes = getSignatureAttributes(item)
|
||||
var itemName = item.name || ""
|
||||
|
||||
if (item.variable) {
|
||||
itemName = "…" + itemName
|
||||
}
|
||||
|
||||
if (attributes && attributes.length) {
|
||||
itemName = util.format(
|
||||
'%s<span class="signature-attributes">%s</span>',
|
||||
itemName,
|
||||
attributes.join(", ")
|
||||
)
|
||||
}
|
||||
|
||||
return itemName
|
||||
}
|
||||
|
||||
function addParamAttributes(params) {
|
||||
return params
|
||||
.filter(function(param) {
|
||||
return param.name && param.name.indexOf(".") === -1
|
||||
})
|
||||
.map(updateItemName)
|
||||
}
|
||||
|
||||
function buildItemTypeStrings(item) {
|
||||
var types = []
|
||||
|
||||
if (item && item.type && item.type.names) {
|
||||
item.type.names.forEach(function(name) {
|
||||
types.push(linkto(name, htmlsafe(name)))
|
||||
})
|
||||
}
|
||||
|
||||
return types
|
||||
}
|
||||
|
||||
function buildAttribsString(attribs) {
|
||||
var attribsString = ""
|
||||
|
||||
if (attribs && attribs.length) {
|
||||
attribsString = htmlsafe(util.format("(%s) ", attribs.join(", ")))
|
||||
}
|
||||
|
||||
return attribsString
|
||||
}
|
||||
|
||||
function addNonParamAttributes(items) {
|
||||
var types = []
|
||||
|
||||
items.forEach(function(item) {
|
||||
types = types.concat(buildItemTypeStrings(item))
|
||||
})
|
||||
|
||||
return types
|
||||
}
|
||||
|
||||
function addSignatureParams(f) {
|
||||
var params = f.params ? addParamAttributes(f.params) : []
|
||||
f.signature = util.format("%s(%s)", f.signature || "", params.join(", "))
|
||||
}
|
||||
|
||||
function addSignatureReturns(f) {
|
||||
var attribs = []
|
||||
var attribsString = ""
|
||||
var returnTypes = []
|
||||
var returnTypesString = ""
|
||||
|
||||
// jam all the return-type attributes into an array. this could create odd results (for example,
|
||||
// if there are both nullable and non-nullable return types), but let's assume that most people
|
||||
// who use multiple @return tags aren't using Closure Compiler type annotations, and vice-versa.
|
||||
if (f.returns) {
|
||||
f.returns.forEach(function(item) {
|
||||
helper.getAttribs(item).forEach(function(attrib) {
|
||||
if (attribs.indexOf(attrib) === -1) {
|
||||
attribs.push(attrib)
|
||||
}
|
||||
})
|
||||
})
|
||||
|
||||
attribsString = buildAttribsString(attribs)
|
||||
}
|
||||
|
||||
if (f.returns) {
|
||||
returnTypes = addNonParamAttributes(f.returns)
|
||||
}
|
||||
if (returnTypes.length) {
|
||||
returnTypesString = util.format(
|
||||
" → %s{%s}",
|
||||
attribsString,
|
||||
returnTypes.join("|")
|
||||
)
|
||||
}
|
||||
|
||||
f.signature =
|
||||
'<span class="signature">' +
|
||||
(f.signature || "") +
|
||||
"</span>" +
|
||||
'<span class="type-signature">' +
|
||||
returnTypesString +
|
||||
"</span>"
|
||||
}
|
||||
|
||||
function addSignatureTypes(f) {
|
||||
var types = f.type ? buildItemTypeStrings(f) : []
|
||||
|
||||
f.signature =
|
||||
(f.signature || "") +
|
||||
'<span class="type-signature">' +
|
||||
(types.length ? " :" + types.join("|") : "") +
|
||||
"</span>"
|
||||
}
|
||||
|
||||
function addAttribs(f) {
|
||||
var attribs = helper.getAttribs(f)
|
||||
var attribsString = buildAttribsString(attribs)
|
||||
|
||||
f.attribs = util.format(
|
||||
'<span class="type-signature">%s</span>',
|
||||
attribsString
|
||||
)
|
||||
}
|
||||
|
||||
function shortenPaths(files, commonPrefix) {
|
||||
Object.keys(files).forEach(function(file) {
|
||||
files[file].shortened = files[file].resolved
|
||||
.replace(commonPrefix, "")
|
||||
// always use forward slashes
|
||||
.replace(/\\/g, "/")
|
||||
})
|
||||
|
||||
return files
|
||||
}
|
||||
|
||||
function getPathFromDoclet(doclet) {
|
||||
if (!doclet.meta) {
|
||||
return null
|
||||
}
|
||||
|
||||
return doclet.meta.path && doclet.meta.path !== "null"
|
||||
? path.join(doclet.meta.path, doclet.meta.filename)
|
||||
: doclet.meta.filename
|
||||
}
|
||||
|
||||
function generate(type, title, docs, filename, resolveLinks) {
|
||||
resolveLinks = resolveLinks === false ? false : true
|
||||
|
||||
var docData = {
|
||||
type: type,
|
||||
title: title,
|
||||
docs: docs
|
||||
}
|
||||
|
||||
var outpath = path.join(outdir, filename),
|
||||
html = view.render("container.tmpl", docData)
|
||||
|
||||
if (resolveLinks) {
|
||||
html = helper.resolveLinks(html) // turn {@link foo} into <a href="foodoc.html">foo</a>
|
||||
}
|
||||
|
||||
fs.writeFileSync(outpath, html, "utf8")
|
||||
}
|
||||
|
||||
function generateSourceFiles(sourceFiles, encoding) {
|
||||
encoding = encoding || "utf8"
|
||||
Object.keys(sourceFiles).forEach(function(file) {
|
||||
var source
|
||||
// links are keyed to the shortened path in each doclet's `meta.shortpath` property
|
||||
var sourceOutfile = helper.getUniqueFilename(sourceFiles[file].shortened)
|
||||
helper.registerLink(sourceFiles[file].shortened, sourceOutfile)
|
||||
|
||||
try {
|
||||
source = {
|
||||
kind: "source",
|
||||
code: helper.htmlsafe(
|
||||
fs.readFileSync(sourceFiles[file].resolved, encoding)
|
||||
)
|
||||
}
|
||||
} catch (e) {
|
||||
logger.error("Error while generating source file %s: %s", file, e.message)
|
||||
}
|
||||
|
||||
generate(
|
||||
"Source",
|
||||
sourceFiles[file].shortened,
|
||||
[source],
|
||||
sourceOutfile,
|
||||
false
|
||||
)
|
||||
})
|
||||
}
|
||||
|
||||
/**
|
||||
* Look for classes or functions with the same name as modules (which indicates that the module
|
||||
* exports only that class or function), then attach the classes or functions to the `module`
|
||||
* property of the appropriate module doclets. The name of each class or function is also updated
|
||||
* for display purposes. This function mutates the original arrays.
|
||||
*
|
||||
* @private
|
||||
* @param {Array.<module:jsdoc/doclet.Doclet>} doclets - The array of classes and functions to
|
||||
* check.
|
||||
* @param {Array.<module:jsdoc/doclet.Doclet>} modules - The array of module doclets to search.
|
||||
*/
|
||||
function attachModuleSymbols(doclets, modules) {
|
||||
var symbols = {}
|
||||
|
||||
// build a lookup table
|
||||
doclets.forEach(function(symbol) {
|
||||
symbols[symbol.longname] = symbols[symbol.longname] || []
|
||||
symbols[symbol.longname].push(symbol)
|
||||
})
|
||||
|
||||
return modules.map(function(module) {
|
||||
if (symbols[module.longname]) {
|
||||
module.modules = symbols[module.longname]
|
||||
// Only show symbols that have a description. Make an exception for classes, because
|
||||
// we want to show the constructor-signature heading no matter what.
|
||||
.filter(function(symbol) {
|
||||
return symbol.description || symbol.kind === "class"
|
||||
})
|
||||
.map(function(symbol) {
|
||||
symbol = doop(symbol)
|
||||
|
||||
if (symbol.kind === "class" || symbol.kind === "function") {
|
||||
symbol.name = symbol.name.replace("module:", '(require("') + '"))'
|
||||
}
|
||||
|
||||
return symbol
|
||||
})
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
/**
|
||||
* Create the navigation sidebar.
|
||||
* @param {object} members The members that will be used to create the sidebar.
|
||||
* @param {array<object>} members.classes
|
||||
* @param {array<object>} members.externals
|
||||
* @param {array<object>} members.globals
|
||||
* @param {array<object>} members.mixins
|
||||
* @param {array<object>} members.modules
|
||||
* @param {array<object>} members.namespaces
|
||||
* @param {array<object>} members.tutorials
|
||||
* @param {array<object>} members.events
|
||||
* @param {array<object>} members.interfaces
|
||||
* @return {array} The HTML for the navigation sidebar.
|
||||
*/
|
||||
function buildNav(members) {
|
||||
var nav = []
|
||||
var seen = {}
|
||||
var seenTutorials = {}
|
||||
|
||||
nav.push(buildNavLink('home', '<a href="index.html">Home</a>'))
|
||||
|
||||
nav = nav.concat(buildMemberNav(members.tutorials, "Tutorials", seenTutorials, linktoTutorial))
|
||||
nav = nav.concat(buildMemberNav(members.classes, "Classes", seen, linkto))
|
||||
nav = nav.concat(buildMemberNav(members.modules, "Modules", {}, linkto))
|
||||
nav = nav.concat(buildMemberNav(members.externals, "Externals", seen, linktoExternal))
|
||||
nav = nav.concat(buildMemberNav(members.events, "Events", seen, linkto))
|
||||
nav = nav.concat(buildMemberNav(members.namespaces, "Namespaces", seen, linkto))
|
||||
nav = nav.concat(buildMemberNav(members.mixins, "Mixins", seen, linkto))
|
||||
nav = nav.concat(buildMemberNav(members.interfaces, "Interfaces", seen, linkto))
|
||||
|
||||
if (members.globals.length) {
|
||||
nav.push(buildNavHeading(linkto('global', 'Globals')))
|
||||
|
||||
members.globals.forEach(function (item) {
|
||||
if (item.kind !== "typedef" && !hasOwnProp.call(seen, item.longname)) {
|
||||
nav.push(buildNavItem(buildNavType(item.kind, linkto(item.longname, item.name))))
|
||||
}
|
||||
|
||||
seen[item.longname] = true
|
||||
})
|
||||
}
|
||||
|
||||
return nav.join('')
|
||||
}
|
||||
|
||||
function buildMemberNav(items, itemHeading, itemsSeen, linktoFn) {
|
||||
var nav = []
|
||||
var conf = env.conf.templates || {}
|
||||
|
||||
conf.default = conf.default || {}
|
||||
|
||||
if (items && items.length) {
|
||||
var itemsNav = ""
|
||||
|
||||
nav.push(buildNavHeading(itemHeading))
|
||||
|
||||
items.forEach(function(item) {
|
||||
var methods = find({ kind: "function", memberof: item.longname })
|
||||
var members = find({ kind: "member", memberof: item.longname })
|
||||
var displayName
|
||||
|
||||
if (!hasOwnProp.call(item, "longname")) {
|
||||
nav.push(buildNavItem(linkfoFn('', item.name)))
|
||||
return
|
||||
}
|
||||
|
||||
if (!hasOwnProp.call(itemsSeen, item.longname)) {
|
||||
if (!!conf.default.useLongnameInNav) {
|
||||
displayName = item.longname
|
||||
|
||||
if (conf.default.useLongnameInNav > 0 && conf.default.useLongnameInNav !== true) {
|
||||
var num = conf.default.useLongnameInNav
|
||||
var cropped = item.longname.split(".").slice(-num).join(".")
|
||||
if (cropped !== displayName) {
|
||||
displayName = "..." + cropped
|
||||
}
|
||||
}
|
||||
} else {
|
||||
displayName = item.name
|
||||
}
|
||||
|
||||
displayName = displayName.replace(/^module:/g, "")
|
||||
|
||||
if (itemHeading === 'Tutorials') {
|
||||
nav.push(buildNavItem(linktoFn(item.longname, displayName)))
|
||||
} else {
|
||||
nav.push(buildNavHeading(buildNavType(item.kind, linktoFn(item.longname, displayName))))
|
||||
}
|
||||
|
||||
if (methods.length) {
|
||||
methods.forEach(function(method) {
|
||||
if (method.inherited && conf.showInheritedInNav === false) {
|
||||
return
|
||||
}
|
||||
|
||||
nav.push(buildNavItem(buildNavType(method.kind, linkto(method.longname, method.name))))
|
||||
})
|
||||
}
|
||||
|
||||
itemsSeen[item.longname] = true
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
return nav
|
||||
}
|
||||
|
||||
function linktoTutorial(longName, name) {
|
||||
return tutoriallink(name)
|
||||
}
|
||||
|
||||
function linktoExternal(longName, name) {
|
||||
return linkto(longName, name.replace(/(^"|"$)/g, ""))
|
||||
}
|
||||
|
||||
/**
|
||||
* Helper to generate navigation list link wrapper around navigation links for
|
||||
* locations.
|
||||
*
|
||||
* @param {String} linkClass navigation link classname
|
||||
* @param {String} linkContent navigation link HTML content
|
||||
* @return {String}
|
||||
*/
|
||||
function buildNavLink (linkClass, linkContent) {
|
||||
return [
|
||||
'<li class="nav-link nav-' + linkClass + '-link">',
|
||||
linkContent,
|
||||
'</li>'
|
||||
].join('')
|
||||
}
|
||||
|
||||
/**
|
||||
* Helper to generate navigation list header wrapper around navigation header content
|
||||
* for headings and filenames.
|
||||
*
|
||||
* @param {String} content navigation header content
|
||||
* @return {String}
|
||||
*/
|
||||
function buildNavHeading (content) {
|
||||
return [
|
||||
'<li class="nav-heading">',
|
||||
content,
|
||||
'</li>'
|
||||
].join('')
|
||||
}
|
||||
|
||||
/**
|
||||
* Helper for generating generic navigation wrapper around content passed for
|
||||
* methods, and types.
|
||||
*
|
||||
* @param {String} itemContent navigation item content
|
||||
* @return {String}
|
||||
*/
|
||||
function buildNavItem (itemContent) {
|
||||
return [
|
||||
'<li class="nav-item">',
|
||||
itemContent,
|
||||
'</li>'
|
||||
].join('')
|
||||
}
|
||||
|
||||
function buildNavType (type, typeLink) {
|
||||
return [
|
||||
'<span class="nav-item-type type-' + type + '">',
|
||||
type[0].toUpperCase(),
|
||||
'</span>',
|
||||
|
||||
'<span class="nav-item-name">',
|
||||
typeLink,
|
||||
'</span>'
|
||||
].join('')
|
||||
}
|
||||
|
||||
/**
|
||||
@param {TAFFY} taffyData See <http://taffydb.com/>.
|
||||
@param {object} opts
|
||||
@param {Tutorial} tutorials
|
||||
*/
|
||||
exports.publish = function(taffyData, opts, tutorials) {
|
||||
data = taffyData
|
||||
|
||||
var conf = env.conf.templates || {}
|
||||
conf.default = conf.default || {}
|
||||
|
||||
var templatePath = path.normalize(opts.template)
|
||||
view = new template.Template(path.join(templatePath, "tmpl"))
|
||||
|
||||
// claim some special filenames in advance, so the All-Powerful Overseer of Filename Uniqueness
|
||||
// doesn't try to hand them out later
|
||||
var indexUrl = helper.getUniqueFilename("index")
|
||||
|
||||
// don't call registerLink() on this one! 'index' is also a valid longname
|
||||
var globalUrl = helper.getUniqueFilename("global")
|
||||
helper.registerLink("global", globalUrl)
|
||||
|
||||
// set up templating
|
||||
view.layout = conf.default.layoutFile
|
||||
? path.getResourcePath(
|
||||
path.dirname(conf.default.layoutFile),
|
||||
path.basename(conf.default.layoutFile)
|
||||
)
|
||||
: "layout.tmpl"
|
||||
|
||||
// set up tutorials for helper
|
||||
helper.setTutorials(tutorials)
|
||||
data = helper.prune(data)
|
||||
data.sort("longname, version, since")
|
||||
helper.addEventListeners(data)
|
||||
|
||||
var sourceFiles = {}
|
||||
var sourceFilePaths = []
|
||||
|
||||
data().each(function (doclet) {
|
||||
doclet.attribs = ""
|
||||
|
||||
if (doclet.examples) {
|
||||
doclet.examples = doclet.examples.map(function(example) {
|
||||
var caption, code
|
||||
|
||||
if (
|
||||
example.match(
|
||||
/^\s*<caption>([\s\S]+?)<\/caption>(\s*[\n\r])([\s\S]+)$/i
|
||||
)
|
||||
) {
|
||||
caption = RegExp.$1
|
||||
code = RegExp.$3
|
||||
}
|
||||
|
||||
return {
|
||||
caption: caption || "",
|
||||
code: code || example
|
||||
}
|
||||
})
|
||||
}
|
||||
|
||||
if (doclet.see) {
|
||||
doclet.see.forEach(function(seeItem, i) {
|
||||
doclet.see[i] = hashToLink(doclet, seeItem)
|
||||
})
|
||||
}
|
||||
|
||||
// build a list of source files
|
||||
var sourcePath
|
||||
if (doclet.meta) {
|
||||
sourcePath = getPathFromDoclet(doclet)
|
||||
|
||||
sourceFiles[sourcePath] = {
|
||||
resolved: sourcePath,
|
||||
shortened: null
|
||||
}
|
||||
|
||||
if (sourceFilePaths.indexOf(sourcePath) === -1) {
|
||||
sourceFilePaths.push(sourcePath)
|
||||
}
|
||||
}
|
||||
})
|
||||
|
||||
// update outdir if necessary, then create outdir
|
||||
var packageInfo = (find({ kind: "package" }) || [])[0]
|
||||
if (packageInfo && packageInfo.name) {
|
||||
outdir = path.join(outdir, packageInfo.name, packageInfo.version || "")
|
||||
}
|
||||
fs.mkPath(outdir)
|
||||
|
||||
// copy the template's static files to outdir
|
||||
var fromDir = path.join(templatePath, "static")
|
||||
var staticFiles = fs.ls(fromDir, 3)
|
||||
|
||||
staticFiles.forEach(function(fileName) {
|
||||
var toDir = fs.toDir(fileName.replace(fromDir, outdir))
|
||||
fs.mkPath(toDir)
|
||||
fs.copyFileSync(fileName, toDir)
|
||||
})
|
||||
|
||||
// copy user-specified static files to outdir
|
||||
var staticFilePaths
|
||||
var staticFileFilter
|
||||
var staticFileScanner
|
||||
if (conf.default.staticFiles) {
|
||||
// The canonical property name is `include`. We accept `paths` for backwards compatibility
|
||||
// with a bug in JSDoc 3.2.x.
|
||||
staticFilePaths = conf.default.staticFiles.include ||
|
||||
conf.default.staticFiles.paths || []
|
||||
staticFileFilter = new (require("jsdoc/src/filter").Filter)(
|
||||
conf.default.staticFiles
|
||||
)
|
||||
staticFileScanner = new (require("jsdoc/src/scanner").Scanner)()
|
||||
|
||||
staticFilePaths.forEach(function(filePath) {
|
||||
var extraStaticFiles = staticFileScanner.scan(
|
||||
[filePath],
|
||||
10,
|
||||
staticFileFilter
|
||||
)
|
||||
|
||||
extraStaticFiles.forEach(function(fileName) {
|
||||
var sourcePath = fs.toDir(filePath)
|
||||
var toDir = fs.toDir(fileName.replace(sourcePath, outdir))
|
||||
fs.mkPath(toDir)
|
||||
fs.copyFileSync(fileName, toDir)
|
||||
})
|
||||
})
|
||||
}
|
||||
|
||||
if (sourceFilePaths.length) {
|
||||
sourceFiles = shortenPaths(sourceFiles, path.commonPrefix(sourceFilePaths))
|
||||
}
|
||||
|
||||
data().each(function(doclet) {
|
||||
var url = helper.createLink(doclet)
|
||||
helper.registerLink(doclet.longname, url)
|
||||
|
||||
// add a shortened version of the full path
|
||||
var docletPath
|
||||
if (doclet.meta) {
|
||||
docletPath = getPathFromDoclet(doclet)
|
||||
docletPath = sourceFiles[docletPath].shortened
|
||||
if (docletPath) {
|
||||
doclet.meta.shortpath = docletPath
|
||||
}
|
||||
}
|
||||
})
|
||||
|
||||
data().each(function(doclet) {
|
||||
var url = helper.longnameToUrl[doclet.longname]
|
||||
|
||||
if (url.indexOf("#") > -1) {
|
||||
doclet.id = helper.longnameToUrl[doclet.longname].split(/#/).pop()
|
||||
} else {
|
||||
doclet.id = doclet.name
|
||||
}
|
||||
|
||||
if (needsSignature(doclet)) {
|
||||
addSignatureParams(doclet)
|
||||
addSignatureReturns(doclet)
|
||||
addAttribs(doclet)
|
||||
}
|
||||
})
|
||||
|
||||
// do this after the urls have all been generated
|
||||
data().each(function(doclet) {
|
||||
doclet.ancestors = getAncestorLinks(doclet)
|
||||
|
||||
if (doclet.kind === "member") {
|
||||
addSignatureTypes(doclet)
|
||||
addAttribs(doclet)
|
||||
}
|
||||
|
||||
if (doclet.kind === "constant") {
|
||||
addSignatureTypes(doclet)
|
||||
addAttribs(doclet)
|
||||
doclet.kind = "member"
|
||||
}
|
||||
})
|
||||
|
||||
var members = helper.getMembers(data)
|
||||
members.tutorials = tutorials.children
|
||||
|
||||
// output pretty-printed source files by default
|
||||
var outputSourceFiles = conf.default &&
|
||||
conf.default.outputSourceFiles !== false
|
||||
? true
|
||||
: false
|
||||
|
||||
// add template helpers
|
||||
view.find = find
|
||||
view.linkto = linkto
|
||||
view.resolveAuthorLinks = resolveAuthorLinks
|
||||
view.tutoriallink = tutoriallink
|
||||
view.htmlsafe = htmlsafe
|
||||
view.outputSourceFiles = outputSourceFiles
|
||||
|
||||
// once for all
|
||||
view.nav = buildNav(members)
|
||||
attachModuleSymbols(find({ longname: { left: "module:" } }), members.modules)
|
||||
|
||||
// generate the pretty-printed source files first so other pages can link to them
|
||||
if (outputSourceFiles) {
|
||||
generateSourceFiles(sourceFiles, opts.encoding)
|
||||
}
|
||||
|
||||
if (members.globals.length) {
|
||||
generate("", "Global", [{ kind: "globalobj" }], globalUrl)
|
||||
}
|
||||
|
||||
// index page displays information from package.json and lists files
|
||||
var files = find({ kind: "file" })
|
||||
var packages = find({ kind: "package" })
|
||||
|
||||
generate(
|
||||
"",
|
||||
"Home",
|
||||
packages
|
||||
.concat([
|
||||
{
|
||||
kind: "mainpage",
|
||||
readme: opts.readme,
|
||||
longname: opts.mainpagetitle ? opts.mainpagetitle : "Main Page"
|
||||
}
|
||||
])
|
||||
.concat(files),
|
||||
indexUrl
|
||||
)
|
||||
|
||||
// set up the lists that we'll use to generate pages
|
||||
var classes = taffy(members.classes)
|
||||
var modules = taffy(members.modules)
|
||||
var namespaces = taffy(members.namespaces)
|
||||
var mixins = taffy(members.mixins)
|
||||
var externals = taffy(members.externals)
|
||||
var interfaces = taffy(members.interfaces)
|
||||
|
||||
Object.keys(helper.longnameToUrl).forEach(function(longname) {
|
||||
var myModules = helper.find(modules, { longname: longname })
|
||||
if (myModules.length) {
|
||||
generate(
|
||||
"Module",
|
||||
myModules[0].name,
|
||||
myModules,
|
||||
helper.longnameToUrl[longname]
|
||||
)
|
||||
}
|
||||
|
||||
var myClasses = helper.find(classes, { longname: longname })
|
||||
if (myClasses.length) {
|
||||
generate(
|
||||
"Class",
|
||||
myClasses[0].name,
|
||||
myClasses,
|
||||
helper.longnameToUrl[longname]
|
||||
)
|
||||
}
|
||||
|
||||
var myNamespaces = helper.find(namespaces, { longname: longname })
|
||||
if (myNamespaces.length) {
|
||||
generate(
|
||||
"Namespace",
|
||||
myNamespaces[0].name,
|
||||
myNamespaces,
|
||||
helper.longnameToUrl[longname]
|
||||
)
|
||||
}
|
||||
|
||||
var myMixins = helper.find(mixins, { longname: longname })
|
||||
if (myMixins.length) {
|
||||
generate(
|
||||
"Mixin",
|
||||
myMixins[0].name,
|
||||
myMixins,
|
||||
helper.longnameToUrl[longname]
|
||||
)
|
||||
}
|
||||
|
||||
var myExternals = helper.find(externals, { longname: longname })
|
||||
if (myExternals.length) {
|
||||
generate(
|
||||
"External",
|
||||
myExternals[0].name,
|
||||
myExternals,
|
||||
helper.longnameToUrl[longname]
|
||||
)
|
||||
}
|
||||
|
||||
var myInterfaces = helper.find(interfaces, { longname: longname })
|
||||
if (myInterfaces.length) {
|
||||
generate(
|
||||
"Interface",
|
||||
myInterfaces[0].name,
|
||||
myInterfaces,
|
||||
helper.longnameToUrl[longname]
|
||||
)
|
||||
}
|
||||
})
|
||||
|
||||
// TODO: move the tutorial functions to templateHelper.js
|
||||
function generateTutorial(title, tutorial, filename) {
|
||||
var tutorialData = {
|
||||
title: title,
|
||||
header: tutorial.title,
|
||||
content: tutorial.parse(),
|
||||
children: tutorial.children
|
||||
}
|
||||
|
||||
var tutorialPath = path.join(outdir, filename)
|
||||
var html = view.render("tutorial.tmpl", tutorialData)
|
||||
|
||||
// yes, you can use {@link} in tutorials too!
|
||||
html = helper.resolveLinks(html) // turn {@link foo} into <a href="foodoc.html">foo</a>
|
||||
fs.writeFileSync(tutorialPath, html, "utf8")
|
||||
}
|
||||
|
||||
// tutorials can have only one parent so there is no risk for loops
|
||||
function saveChildren(node) {
|
||||
node.children.forEach(function(child) {
|
||||
generateTutorial(
|
||||
child.title,
|
||||
child,
|
||||
helper.tutorialToUrl(child.name)
|
||||
)
|
||||
saveChildren(child)
|
||||
})
|
||||
}
|
||||
|
||||
saveChildren(tutorials)
|
||||
}
|
||||
BIN
docs/template/static/fonts/OpenSans-Bold-webfont.eot
vendored
Normal file
1830
docs/template/static/fonts/OpenSans-Bold-webfont.svg
vendored
Normal file
|
After Width: | Height: | Size: 116 KiB |
BIN
docs/template/static/fonts/OpenSans-Bold-webfont.woff
vendored
Normal file
BIN
docs/template/static/fonts/OpenSans-BoldItalic-webfont.eot
vendored
Normal file
1830
docs/template/static/fonts/OpenSans-BoldItalic-webfont.svg
vendored
Normal file
|
After Width: | Height: | Size: 118 KiB |
BIN
docs/template/static/fonts/OpenSans-BoldItalic-webfont.woff
vendored
Normal file
BIN
docs/template/static/fonts/OpenSans-Italic-webfont.eot
vendored
Normal file
1830
docs/template/static/fonts/OpenSans-Italic-webfont.svg
vendored
Normal file
|
After Width: | Height: | Size: 120 KiB |
BIN
docs/template/static/fonts/OpenSans-Italic-webfont.woff
vendored
Normal file
BIN
docs/template/static/fonts/OpenSans-Light-webfont.eot
vendored
Normal file
1831
docs/template/static/fonts/OpenSans-Light-webfont.svg
vendored
Normal file
|
After Width: | Height: | Size: 114 KiB |
BIN
docs/template/static/fonts/OpenSans-Light-webfont.woff
vendored
Normal file
BIN
docs/template/static/fonts/OpenSans-LightItalic-webfont.eot
vendored
Normal file
1835
docs/template/static/fonts/OpenSans-LightItalic-webfont.svg
vendored
Normal file
|
After Width: | Height: | Size: 120 KiB |
BIN
docs/template/static/fonts/OpenSans-LightItalic-webfont.woff
vendored
Normal file
BIN
docs/template/static/fonts/OpenSans-Regular-webfont.eot
vendored
Normal file
1831
docs/template/static/fonts/OpenSans-Regular-webfont.svg
vendored
Normal file
|
After Width: | Height: | Size: 117 KiB |