api docs update

This commit is contained in:
azivner
2018-10-07 16:27:12 +02:00
parent b5bb653889
commit 24673168bb
34 changed files with 413 additions and 55 deletions

View File

@@ -33,6 +33,7 @@ import infoService from './info.js';
import linkService from './link.js';
import treeCache from './tree_cache.js';
import noteDetailService from './note_detail.js';
import noteTypeService from './note_type.js';
/**
* This is the main frontend API interface for scripts. It's published in the local "api" object.
@@ -229,9 +230,27 @@ function FrontendScriptApi(startNote, currentNote, originEntity = null) {
/**
* @method
* @param {function} func - callback called on note change
* @param {function} func - callback called on note change as user is typing (not necessarily tied to save event)
*/
this.onNoteChange = noteDetailService.onNoteChange;
/**
* @method
* @returns {array} list of default code mime types
*/
this.getDefaultCodeMimeTypes = noteTypeService.getDefaultCodeMimeTypes;
/**
* @method
* @returns {array} list of currently used code mime types
*/
this.getCodeMimeTypes = noteTypeService.getCodeMimeTypes;
/**
* @method
* @param {array} types - list of mime types to be used
*/
this.setCodeMimeTypes = noteTypeService.setCodeMimeTypes;
}
export default FrontendScriptApi;</code></pre>
@@ -250,7 +269,7 @@ export default FrontendScriptApi;</code></pre>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Sep 03 2018 16:04:46 GMT+0200 (CEST)
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Sun Oct 07 2018 16:27:00 GMT+0200 (CEST)
</footer>
<script> prettyPrint(); </script>