Updated code documentation #12

os-js · Jan 15, 2015 · dc4f0a2 · dc4f0a2
1 parent 9827355
commit dc4f0a2
Show file tree

Hide file tree

Showing 11 changed files with 142 additions and 11 deletions.
diff --git a/src/javascript/dialogs/alert.js b/src/javascript/dialogs/alert.js
@@ -32,6 +32,16 @@
 
   /**
    * Alert/Message Dialog
+   *
+   * @param   String    msg     Message
+   * @param   Function  onClose Callback on close => fn(button)
+   * @param   Object    args    List of arguments (Will be passed on to StandardDialog)
+   *
+   * @api OSjs.Dialogs.AlertDialog
+   * @see OSjs.Dialogs.StandardDialog
+   *
+   * @extends StandardDialog
+   * @class
    */
   var AlertDialog = function(msg, onClose, args) {
     args = Utils.mergeObject({title: API._('DIALOG_ALERT_TITLE'), message: msg, buttonCancel: false, buttonOkLabel: API._('DIALOG_CLOSE')}, (args || {}));

diff --git a/src/javascript/dialogs/applicationchooser.js b/src/javascript/dialogs/applicationchooser.js
@@ -32,6 +32,16 @@
 
   /**
    * Application Chooser Dialog
+   *
+   * @param   OSjs.VFS.File   file    The requested File
+   * @param   Array           list    The list of applications
+   * @param   Function        onClose Callback on close => fn(button)
+   *
+   * @api OSjs.Dialogs.ApplicationChooserDialog
+   * @see OSjs.Dialogs.StandardDialog
+   *
+   * @extends StandardDialog
+   * @class
    */
   var ApplicationChooserDialog = function(file, list, onClose) {
     this.filename     = Utils.filename(file.path);

diff --git a/src/javascript/dialogs/color.js b/src/javascript/dialogs/color.js
@@ -32,6 +32,15 @@
 
   /**
    * Color Dialog
+   *
+   * @param   Object          opts    Options
+   * @param   Function        onClose Callback on close => fn(button, rgb, hex, alpha)
+   *
+   * @api OSjs.Dialogs.ColorDialog
+   * @see OSjs.Dialogs.StandardDialog
+   *
+   * @extends StandardDialog
+   * @class
    */
   var ColorDialog = function(opts, onClose) {
     opts = opts || {};

diff --git a/src/javascript/dialogs/confirm.js b/src/javascript/dialogs/confirm.js
@@ -32,6 +32,16 @@
 
   /**
    * Confirmation Dialog
+   *
+   * @param   String          msg     Confirm message
+   * @param   Function        onClose Callback on close => fn(button)
+   * @param   Object          args    List of arguments (Will be passed on to StandardDialog)
+   *
+   * @api OSjs.Dialogs.ConfirmDialog
+   * @see OSjs.Dialogs.StandardDialog
+   *
+   * @extends StandardDialog
+   * @class
    */
   var ConfirmDialog = function(msg, onClose, args) {
     args = Utils.mergeObject({title: API._('DIALOG_CONFIRM_TITLE'), message: msg}, (args || {}));

diff --git a/src/javascript/dialogs/errormessage.js b/src/javascript/dialogs/errormessage.js
@@ -32,6 +32,14 @@
 
   /**
    * ErrorDialog implementation
+   *
+   * THIS IS FOR INTERNAL USAGE ONLY
+   *
+   * @api OSjs.Dialogs.ErrorDialog
+   * @see OSjs.Dialogs.StandardDialog
+   *
+   * @extends StandardDialog
+   * @class
    */
   var ErrorDialog = function() {
     this.data = {title: 'No title', message: 'No message', error: ''};

diff --git a/src/javascript/dialogs/file.js b/src/javascript/dialogs/file.js
@@ -31,18 +31,27 @@
   'use strict';
 
   /**
-   * Init
+   * File Chooser Dialog
    *
-   * Arguments:
-   *  type                  Dialog type: "open" or "save"
-   *  select                Selection type: "file" or "dir"
-   *  path                  Current path
-   *  filename              Current filename
-   *  mime                  Current file MIME
-   *  mimes                 Browse filetype filter (defaults to [none] all files)
-   *  filetypes             Save filetypes dict (ext => mime)
-   *  defaultFilename       Default filename
-   *  defaultFilemime       Default filemime (defaults to given MIME)
+   *
+   * @param   Object          args    Options
+   * @param   Function        onClose Callback on close => fn(button, file)
+   *
+   * @option args String  type                  Dialog type: "open" or "save"
+   * @option args String  select                Selection type: "file" or "dir"
+   * @option args String  path                  Current path
+   * @option args String  filename              Current filename
+   * @option args String  mime                  Current file MIME
+   * @option args String  mimes                 Browse filetype filter (defaults to [none] all files)
+   * @option args String  filetypes             Save filetypes dict (ext => mime)
+   * @option args String  defaultFilename       Default filename
+   * @option args String  defaultFilemime       Default filemime (defaults to given MIME)
+   *
+   * @api OSjs.Dialogs.FileDialog
+   * @see OSjs.Dialogs.StandardDialog
+   *
+   * @extends StandardDialog
+   * @class
    */
   var FileDialog = function(args, onClose) {
     args = args || {};

diff --git a/src/javascript/dialogs/fileinfo.js b/src/javascript/dialogs/fileinfo.js
@@ -32,6 +32,15 @@
 
   /**
    * File Information Dialog
+   *
+   * @param   OSjs.VFS.File   file    The requested File
+   * @param   Function        onClose Callback on close => fn(button)
+   *
+   * @api OSjs.Dialogs.FileInformationDialog
+   * @see OSjs.Dialogs.StandardDialog
+   *
+   * @extends StandardDialog
+   * @class
    */
   var FileInformationDialog = function(file, onClose) {
     this.path = file ? file.path : null;

diff --git a/src/javascript/dialogs/fileprogress.js b/src/javascript/dialogs/fileprogress.js
@@ -32,6 +32,14 @@
 
   /**
    * File Progress dialog
+   *
+   * @param   String          title   Dialog title/message
+   *
+   * @api OSjs.Dialogs.FileProgressDialog
+   * @see OSjs.Core.DialogWindow
+   *
+   * @extends DialogWindow
+   * @class
    */
   var FileProgressDialog = function(title) {
     DialogWindow.apply(this, ['FileProgressDialog', {width:400, height:120}]);
@@ -69,11 +77,29 @@
     this.$desc = desc;
   };
 
+  /**
+   * Set the description
+   *
+   * @param   String    d     Description
+   *
+   * @return  void
+   *
+   * @method  FileProgressDialog::setDescription()
+   */
   FileProgressDialog.prototype.setDescription = function(d) {
     if ( !this.$desc ) { return; }
     this.$desc.innerHTML = d;
   };
 
+  /**
+   * Set the progress
+   *
+   * @param   int     p       Percentage
+   *
+   * @return  void
+   *
+   * @method  FileProgressDialog::setProgress()
+   */
   FileProgressDialog.prototype.setProgress = function(p) {
     var el = this._getGUIElement('FileProgressBar');
     if ( el ) {

diff --git a/src/javascript/dialogs/fileupload.js b/src/javascript/dialogs/fileupload.js
@@ -34,6 +34,16 @@
 
   /**
    * File Upload Dialog
+   *
+   * @param   String          dest    Destination path
+   * @param   [File]          file    File to upload (If null, you will be asked)
+   * @param   Function        onClose Callback on close => fn(button)
+   *
+   * @api OSjs.Dialogs.FileUploadDialog
+   * @see OSjs.Dialogs.StandardDialog
+   *
+   * @extends StandardDialog
+   * @class
    */
   var FileUploadDialog = function(dest, file, onClose) {
     this.dest             = dest;

diff --git a/src/javascript/dialogs/font.js b/src/javascript/dialogs/font.js
@@ -32,6 +32,25 @@
 
   /**
    * Font Dialog
+   *
+   * @param   Object          args    Options
+   * @param   Function        onClose Callback on close => fn(button, fontName, fontSize)
+   *
+   * @option  args    String    name            Default font name (optional)
+   * @option  args    int       size            Default font size (optional)
+   * @option  args    String    background      Background color (default=#ffffff)
+   * @option  args    String    color           Foreground color (default=#000000)
+   * @option  args    Array     list            List of fonts (optional)
+   * @option  args    String    sizeType        Font size type (default=px)
+   * @option  args    String    text            Text to display on preview (optional)
+   * @option  args    int       minSize         Minimum font size (optional)
+   * @option  args    int       maxSize         Maximum font size (optional)
+   *
+   * @api OSjs.Dialogs.FontDialog
+   * @see OSjs.Dialogs.StandardDialog
+   *
+   * @extends StandardDialog
+   * @class
    */
   var FontDialog = function(args, onClose) {
     args = args || {};

diff --git a/src/javascript/dialogs/input.js b/src/javascript/dialogs/input.js
@@ -32,6 +32,17 @@
 
   /**
    * Input Dialog
+   *
+   * @param   String          msg         Message to display
+   * @param   String          val         Default input value (optional)
+   * @param   Function        onClose     Callback on close => fn(button, input)
+   * @param   Function        onCreated   Callback on input init/create
+   *
+   * @api OSjs.Dialogs.InputDialog
+   * @see OSjs.Dialogs.StandardDialog
+   *
+   * @extends StandardDialog
+   * @class
    */
   var InputDialog = function(msg, val, onClose, onCreated) {
     StandardDialog.apply(this, ['InputDialog', {title: API._('DIALOG_INPUT_TITLE'), message: msg}, {width:300, height:150}, onClose]);