Add logger and JSDOC
This commit is contained in:
@@ -1,4 +1,9 @@
|
||||
export default class Canvas {
|
||||
/**
|
||||
* @class
|
||||
*/
|
||||
class Canvas {
|
||||
images = [];
|
||||
|
||||
}
|
||||
|
||||
export default Canvas;
|
||||
|
||||
11
src/IIIFResource.js
Normal file
11
src/IIIFResource.js
Normal file
@@ -0,0 +1,11 @@
|
||||
/**
|
||||
* @interface
|
||||
*/
|
||||
class IIIFResource {
|
||||
id;
|
||||
type;
|
||||
|
||||
toObject() {}
|
||||
}
|
||||
|
||||
export default IIIFResource;
|
||||
@@ -1,7 +1,12 @@
|
||||
import IIIFResource from './IIIFResource.js';
|
||||
import Sequence from "./Sequence.js";
|
||||
import Canvas from "./Canvas.js";
|
||||
|
||||
export default class Manifest {
|
||||
/**
|
||||
* @implements IIIFResource
|
||||
* @class
|
||||
*/
|
||||
class Manifest {
|
||||
id = '';
|
||||
type = 'sc:Manifest';
|
||||
/**
|
||||
@@ -27,7 +32,6 @@ export default class Manifest {
|
||||
|
||||
}
|
||||
/**
|
||||
* @todo Implement
|
||||
* @param {string} idParam From the request
|
||||
*/
|
||||
generateID(idParam) {
|
||||
@@ -35,6 +39,7 @@ export default class Manifest {
|
||||
}
|
||||
/**
|
||||
* @todo Implement
|
||||
* @returns {object}
|
||||
*/
|
||||
toObject() {
|
||||
return {
|
||||
@@ -44,3 +49,5 @@ export default class Manifest {
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
export default Manifest;
|
||||
@@ -1,3 +1,11 @@
|
||||
export default class Sequence {
|
||||
import IIIFResource from './IIIFResource.js';
|
||||
/**
|
||||
* @todo Not needed in IIIF API v3,
|
||||
* replaced by items
|
||||
* @implements IIIFResource
|
||||
* @class
|
||||
*/
|
||||
class Sequence {
|
||||
|
||||
}
|
||||
export default Sequence;
|
||||
20
src/jsdoc.json
Normal file
20
src/jsdoc.json
Normal file
@@ -0,0 +1,20 @@
|
||||
{
|
||||
"source": {
|
||||
"include": ["src/"],
|
||||
"includePattern": ".js$",
|
||||
"excludePattern": "(node_modules/|docs)"
|
||||
},
|
||||
|
||||
"plugins": ["plugins/markdown"],
|
||||
|
||||
"opts": {
|
||||
"encoding": "utf8",
|
||||
"destination": "docs/",
|
||||
"recurse": true,
|
||||
"verbose": true,
|
||||
"template": "/home/nicolo/.npm-global/lib/node_modules/clean-jsdoc-theme",
|
||||
"theme_opts": {
|
||||
"theme": "light"
|
||||
}
|
||||
}
|
||||
}
|
||||
Reference in New Issue
Block a user