Skip to content

Commit

Permalink
Docs: Improve Documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@jy95
jy95 committed Aug 27, 2017
1 parent 2f60592 commit 5a42931
Show file tree
Hide file tree
Showing 13 changed files with 453 additions and 199 deletions.
470 changes: 305 additions & 165 deletions docs/TorrentLibrary.html
View file

Large diffs are not rendered by default.

73 changes: 65 additions & 8 deletions docs/TorrentLibrary.js.html
View file
Expand Up @@ -24,7 +24,7 @@
<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="TorrentLibrary.html">TorrentLibrary</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="TorrentLibrary.html#.listVideosExtension">listVideosExtension</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="TorrentLibrary.html#addNewPath">addNewPath</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="TorrentLibrary.html#hasPathsProvidedByUser">hasPathsProvidedByUser</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="TorrentLibrary.html#scan">scan</a></span></li><li class="nav-heading">Externals</li><li class="nav-heading"><span class="nav-item-type type-external">E</span><span class="nav-item-name"><a href="external-access.html">access</a></span></li><li class="nav-heading"><span class="nav-item-type type-external">E</span><span class="nav-item-name"><a href="external-basename.html">basename</a></span></li><li class="nav-heading"><span class="nav-item-type type-external">E</span><span class="nav-item-name"><a href="external-difference.html">difference</a></span></li><li class="nav-heading"><span class="nav-item-type type-external">E</span><span class="nav-item-name"><a href="external-FileHound.html">FileHound</a></span></li><li class="nav-heading"><span class="nav-item-type type-external">E</span><span class="nav-item-name"><a href="external-nameParser.html">nameParser</a></span></li><li class="nav-heading"><span class="nav-item-type type-external">E</span><span class="nav-item-name"><a href="external-Promise.html">Promise</a></span></li><li class="nav-heading"><span class="nav-item-type type-external">E</span><span class="nav-item-name"><a href="external-uniq.html">uniq</a></span></li><li class="nav-heading"><span class="nav-item-type type-external">E</span><span class="nav-item-name"><a href="external-videosExtension.html">videosExtension</a></span></li><li class="nav-heading"><a href="global.html">Globals</a></li>
<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="TorrentLibrary.html">TorrentLibrary</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="TorrentLibrary.html#.listVideosExtension">listVideosExtension</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="TorrentLibrary.html#addNewPath">addNewPath</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="TorrentLibrary.html#allFilesWithCategory">allFilesWithCategory</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="TorrentLibrary.html#allMovies">allMovies</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="TorrentLibrary.html#allTvSeries">allTvSeries</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="TorrentLibrary.html#hasPathsProvidedByUser">hasPathsProvidedByUser</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="TorrentLibrary.html#scan">scan</a></span></li><li class="nav-heading">Externals</li><li class="nav-heading"><span class="nav-item-type type-external">E</span><span class="nav-item-name"><a href="external-access.html">access</a></span></li><li class="nav-heading"><span class="nav-item-type type-external">E</span><span class="nav-item-name"><a href="external-basename.html">basename</a></span></li><li class="nav-heading"><span class="nav-item-type type-external">E</span><span class="nav-item-name"><a href="external-difference.html">difference</a></span></li><li class="nav-heading"><span class="nav-item-type type-external">E</span><span class="nav-item-name"><a href="external-FileHound.html">FileHound</a></span></li><li class="nav-heading"><span class="nav-item-type type-external">E</span><span class="nav-item-name"><a href="external-nameParser.html">nameParser</a></span></li><li class="nav-heading"><span class="nav-item-type type-external">E</span><span class="nav-item-name"><a href="external-Promise.html">Promise</a></span></li><li class="nav-heading"><span class="nav-item-type type-external">E</span><span class="nav-item-name"><a href="external-uniq.html">uniq</a></span></li><li class="nav-heading"><span class="nav-item-type type-external">E</span><span class="nav-item-name"><a href="external-videosExtension.html">videosExtension</a></span></li><li class="nav-heading"><a href="global.html">Globals</a></li>
</nav>

<div id="main">
Expand Down Expand Up @@ -173,6 +173,7 @@ <h1 class="page-title">TorrentLibrary.js</h1>

/**
* Class representing the TorrentLibrary
* @class
* @extends EventEmitter
* @see {@link https://nodejs.org/api/events.html#events_class_eventemitter } for further information.
*/
Expand All @@ -181,15 +182,18 @@ <h1 class="page-title">TorrentLibrary.js</h1>
/**
* constant for movie category
* @since 0.0.0
* @return {string}
* @return {string} the movies constant
* @static
*/
static get MOVIES_TYPE() {
return "MOVIES"
}

/**
* constant for tv series category
* @return {string}
* @return {string} tv series constant
* @since 0.0.0
* @static
*/
static get TV_SERIES_TYPE() {
return "TV_SERIES"
Expand Down Expand Up @@ -225,7 +229,7 @@ <h1 class="page-title">TorrentLibrary.js</h1>
]);
/**
* Mapping filepath => category
* @type {Map}
* @type {Map.&lt;string,string>}
* @example
* { "D:\somePath\Captain Russia The Summer Soldier (2014) 1080p BrRip x264.MKV" => TorrentLibrary.MOVIES_TYPE }
*/
Expand Down Expand Up @@ -323,7 +327,9 @@ <h1 class="page-title">TorrentLibrary.js</h1>

/**
* Add the path(s) to be analyzed by the library if they exist and are readable
* @param {(string|string[])} paths - A path or an array of paths
* @param {string} paths - A or more path(s)
* @instance
* @method
* @since 0.0.0
* @example
* // return resolved Promise "All paths were added!"
Expand Down Expand Up @@ -356,15 +362,19 @@ <h1 class="page-title">TorrentLibrary.js</h1>

/**
* Tell us if the user has provided us paths
* @instance
* @method
* @since 0.0.0
* @returns {boolean}
* @returns {boolean} Has user provided us paths ?
*/
hasPathsProvidedByUser() {
return this.paths.length === 0;
}

/**
* Scans the paths in search for new files to be added inside this lib
* @instance
* @method
* @since 0.0.0
* @return {external:Promise} On success the promise will be resolved with "Scanning completed"&lt;br>
* On error the promise will be rejected with an Error object from sub modules&lt;br>
Expand All @@ -391,25 +401,72 @@ <h1 class="page-title">TorrentLibrary.js</h1>

/**
* Getter for all found movies
* @instance
* @method
* @since 0.0.0
* @return {Set.&lt;TPN_Extended>}
* @example
* // an JSON stringified example of this method
* [
* {
* "year":2012,
* "quality":"DVDRiP",
* "codec":"XviD",
* "group":"-www.zone-telechargement.ws.avi",
* "container":"avi",
* "language":"TRUEFRENCH",
* "title":"Bad Ass",
* "excess":"LiMiTED",
* "filePath":"D:\\workspaceNodeJs\\torrent-files-library\\test\\folder1\\Bad.Ass.2012.LiMiTED.TRUEFRENCH.DVDRiP.XviD-www.zone-telechargement.ws.avi"
* }
* ]
*/
get allMovies() {
return this.stores.get(TorrentLibrary.MOVIES_TYPE);
}

/**
* Getter for all found tv-series
* @instance
* @method
* @since 0.0.0
* @return {Map.&lt;string, Set.&lt;TPN_Extended>>}
* @example
* // an JSON stringified example of this method
* {
* "The Blacklist":[
* {
* "season":4,
* "episode":21,
* "quality":"WEBRip",
* "codec":"XviD",
* "container":"avi",
* "language":"FRENCH",
* "title":"The Blacklist",
* "filePath":"D:\\workspaceNodeJs\\torrent-files-library\\test\\folder1\\The.Blacklist.S04E21.FRENCH.WEBRip.XviD.avi"
* },
* {
* "season":4,
* "episode":14,
* "quality":"WEBRip",
* "codec":"XviD",
* "container":"avi",
* "language":"FRENCH",
* "title":"The Blacklist",
* "filePath":"D:\\workspaceNodeJs\\torrent-files-library\\test\\folder2\\The.Blacklist.S04E14.FRENCH.WEBRip.XviD.avi"
* }
* ]
* }
*/
get allTvSeries() {
return this.stores.get(TorrentLibrary.TV_SERIES_TYPE);
}

/**
* return the mapping between filepaths and category
* @return {Map}
* @return {Map.&lt;string,string>}
* @instance
* @method
* @since 0.0.0
* @example
* { "D:\somePath\Captain Russia The Summer Soldier (2014) 1080p BrRip x264.MKV" => TorrentLibrary.MOVIES_TYPE }
Expand Down Expand Up @@ -461,7 +518,7 @@ <h1 class="page-title">TorrentLibrary.js</h1>
<br class="clear">

<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.4</a> on Sun Aug 27 2017 01:13:41 GMT+0200 (Romance Daylight Time) using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.4</a> on Sun Aug 27 2017 11:46:37 GMT+0200 (Romance Daylight Time) using the Minami theme.
</footer>

<script>prettyPrint();</script>
Expand Down
4 changes: 2 additions & 2 deletions docs/external-FileHound.html
View file
Expand Up @@ -24,7 +24,7 @@
<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="TorrentLibrary.html">TorrentLibrary</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="TorrentLibrary.html#.listVideosExtension">listVideosExtension</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="TorrentLibrary.html#addNewPath">addNewPath</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="TorrentLibrary.html#hasPathsProvidedByUser">hasPathsProvidedByUser</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="TorrentLibrary.html#scan">scan</a></span></li><li class="nav-heading">Externals</li><li class="nav-heading"><span class="nav-item-type type-external">E</span><span class="nav-item-name"><a href="external-access.html">access</a></span></li><li class="nav-heading"><span class="nav-item-type type-external">E</span><span class="nav-item-name"><a href="external-basename.html">basename</a></span></li><li class="nav-heading"><span class="nav-item-type type-external">E</span><span class="nav-item-name"><a href="external-difference.html">difference</a></span></li><li class="nav-heading"><span class="nav-item-type type-external">E</span><span class="nav-item-name"><a href="external-FileHound.html">FileHound</a></span></li><li class="nav-heading"><span class="nav-item-type type-external">E</span><span class="nav-item-name"><a href="external-nameParser.html">nameParser</a></span></li><li class="nav-heading"><span class="nav-item-type type-external">E</span><span class="nav-item-name"><a href="external-Promise.html">Promise</a></span></li><li class="nav-heading"><span class="nav-item-type type-external">E</span><span class="nav-item-name"><a href="external-uniq.html">uniq</a></span></li><li class="nav-heading"><span class="nav-item-type type-external">E</span><span class="nav-item-name"><a href="external-videosExtension.html">videosExtension</a></span></li><li class="nav-heading"><a href="global.html">Globals</a></li>
<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="TorrentLibrary.html">TorrentLibrary</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="TorrentLibrary.html#.listVideosExtension">listVideosExtension</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="TorrentLibrary.html#addNewPath">addNewPath</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="TorrentLibrary.html#allFilesWithCategory">allFilesWithCategory</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="TorrentLibrary.html#allMovies">allMovies</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="TorrentLibrary.html#allTvSeries">allTvSeries</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="TorrentLibrary.html#hasPathsProvidedByUser">hasPathsProvidedByUser</a></span></li><li class="nav-item"><span class="nav-item-type type-function">F</span><span class="nav-item-name"><a href="TorrentLibrary.html#scan">scan</a></span></li><li class="nav-heading">Externals</li><li class="nav-heading"><span class="nav-item-type type-external">E</span><span class="nav-item-name"><a href="external-access.html">access</a></span></li><li class="nav-heading"><span class="nav-item-type type-external">E</span><span class="nav-item-name"><a href="external-basename.html">basename</a></span></li><li class="nav-heading"><span class="nav-item-type type-external">E</span><span class="nav-item-name"><a href="external-difference.html">difference</a></span></li><li class="nav-heading"><span class="nav-item-type type-external">E</span><span class="nav-item-name"><a href="external-FileHound.html">FileHound</a></span></li><li class="nav-heading"><span class="nav-item-type type-external">E</span><span class="nav-item-name"><a href="external-nameParser.html">nameParser</a></span></li><li class="nav-heading"><span class="nav-item-type type-external">E</span><span class="nav-item-name"><a href="external-Promise.html">Promise</a></span></li><li class="nav-heading"><span class="nav-item-type type-external">E</span><span class="nav-item-name"><a href="external-uniq.html">uniq</a></span></li><li class="nav-heading"><span class="nav-item-type type-external">E</span><span class="nav-item-name"><a href="external-videosExtension.html">videosExtension</a></span></li><li class="nav-heading"><a href="global.html">Globals</a></li>
</nav>

<div id="main">
Expand Down Expand Up @@ -139,7 +139,7 @@ <h2>
<br class="clear">

<footer>
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.4</a> on Sun Aug 27 2017 01:13:41 GMT+0200 (Romance Daylight Time) using the Minami theme.
Generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.4</a> on Sun Aug 27 2017 11:46:37 GMT+0200 (Romance Daylight Time) using the Minami theme.
</footer>

<script>prettyPrint();</script>
Expand Down

0 comments on commit 5a42931

Please sign in to comment.