Merge pull request #11988 from nextcloud/docs/jsdoc-build

JSdoc build fixes and move build script out of the root folder

apps/comments/js/commentsmodifymenu.js

@@ -15,6 +15,7 @@
 	 * Construct a new CommentsModifyMenuinstance
 	 * @constructs CommentsModifyMenu
 	 * @memberof OC.Comments
+	 * @private
 	 */
 	var CommentsModifyMenu = OC.Backbone.View.extend({
 		tagName: 'div',

apps/files/js/favoritesplugin.js

@@ -10,9 +10,9 @@
 
 (function(OCA) {
 	/**
-	 * @namespace OCA.Files.FavoritesPlugin
-	 *
 	 * Registers the favorites file list from the files app sidebar.
+	 *
+	 * @namespace OCA.Files.FavoritesPlugin
 	 */
 	OCA.Files.FavoritesPlugin = {
 		name: 'Favorites',

apps/files/js/recentplugin.js

@@ -10,9 +10,9 @@
 
 (function (OCA) {
 	/**
-	 * @namespace OCA.Files.RecentPlugin
-	 *
 	 * Registers the recent file list from the files app sidebar.
+	 *
+	 * @namespace OCA.Files.RecentPlugin
 	 */
 	OCA.Files.RecentPlugin = {
 		name: 'Recent',

apps/files/js/tagsplugin.js

@@ -132,11 +132,11 @@
 	OCA.Files = OCA.Files || {};
 
 	/**
-	 * @namespace OCA.Files.TagsPlugin
-	 *
 	 * Extends the file actions and file list to include a favorite mark icon
 	 * and a favorite action in the file actions menu; it also adds "data-tags"
 	 * and "data-favorite" attributes to file elements.
+	 *
+	 * @namespace OCA.Files.TagsPlugin
 	 */
 	OCA.Files.TagsPlugin = {
 		name: 'Tags',

buildjsdocs.sh → build/buildjsdocs.sh

@@ -8,10 +8,9 @@
 # @copyright 2014 Vincent Petry <pvince81@owncloud.com>
 #
 NPM="$(which npm 2>/dev/null)"
-PREFIX="build"
-OUTPUT_DIR="build/jsdocs"
+OUTPUT_DIR="jsdocs"
 
-JS_FILES="core/js/*.js core/js/**/*.js apps/*/js/*.js"
+JS_FILES="../core/js/*.js ../core/js/**/*.js ../apps/*/js/*.js"
 
 if test -z "$NPM"
 then
@@ -20,14 +19,14 @@ then
 fi
 
 # update/install test packages
-mkdir -p "$PREFIX" && $NPM install --link --prefix "$PREFIX" jsdoc || exit 3
+$NPM install --prefix . --link jsdoc || exit 3
 
 JSDOC_BIN="$(which jsdoc 2>/dev/null)"
 
 # If not installed globally, try local version
 if test -z "$JSDOC_BIN"
 then
-	JSDOC_BIN="$PREFIX/node_modules/jsdoc/jsdoc.js"
+	JSDOC_BIN="./node_modules/jsdoc/jsdoc.js"
 fi
 
 if test -z "$JSDOC_BIN"
@@ -38,5 +37,5 @@ fi
 
 mkdir -p "$OUTPUT_DIR"
 
-NODE_PATH="$PREFIX/node_modules" $JSDOC_BIN -d "$OUTPUT_DIR" $JS_FILES
+NODE_PATH="./node_modules" $JSDOC_BIN -d "$OUTPUT_DIR" $JS_FILES
 

build/files-checker.php

@@ -46,7 +46,6 @@ $expectedFiles = [
 	'autotest.sh',
 	'bower.json',
 	'build',
-	'buildjsdocs.sh',
 	'CHANGELOG.md',
 	'CODE_OF_CONDUCT.md',
 	'composer.json',

build/package.json

@@ -15,7 +15,7 @@
     "handlebars": "^4.0.5",
     "jasmine-core": "~2.5.2",
     "jasmine-sinon": "^0.4.0",
-    "jsdoc": "~3.5.5",
+    "jsdoc": "^3.5.5",
     "karma": "^2.0.2",
     "karma-coverage": "*",
     "karma-jasmine": "^1.1.2",

core/js/contactsmenu.js

@@ -22,6 +22,10 @@
  *
  */
 
+/**
+ * @module OC.ContactsMenu
+ * @private
+ */
 (function(OC, $, _, Handlebars) {
 	'use strict';
 
@@ -56,6 +60,7 @@
 
 	/**
 	 * @class ContactCollection
+	 * @private
 	 */
 	var ContactCollection = OC.Backbone.Collection.extend({
 		model: Contact
@@ -63,10 +68,11 @@
 
 	/**
 	 * @class ContactsListView
+	 * @private
 	 */
 	var ContactsListView = OC.Backbone.View.extend({
 
-		/** @type {ContactsCollection} */
+		/** @type {ContactCollection} */
 		_collection: undefined,
 
 		/** @type {array} */
@@ -115,7 +121,8 @@
 	});
 
 	/**
-	 * @class CotnactsListItemView
+	 * @class ContactsListItemView
+	 * @private
 	 */
 	var ContactsListItemView = OC.Backbone.View.extend({
 
@@ -205,6 +212,7 @@
 
 	/**
 	 * @class ContactsMenuView
+	 * @private
 	 */
 	var ContactsMenuView = OC.Backbone.View.extend({
 
@@ -364,6 +372,7 @@
 	 * @param {jQuery} options.el
 	 * @param {jQuery} options.trigger
 	 * @class ContactsMenu
+	 * @memberOf OC
 	 */
 	var ContactsMenu = function(options) {
 		this.initialize(options);

core/js/files/client.js

@@ -837,7 +837,7 @@
 		/**
 		 * Add a file info parser function
 		 *
-		 * @param {OC.Files.Client~parseFileInfo>}
+		 * @param {OC.Files.Client~parseFileInfo} parserFunction
 		 */
 		addFileInfoParser: function(parserFunction) {
 			this._fileInfoParsers.push(parserFunction);

core/js/js.js

@@ -38,8 +38,11 @@ function escapeHTML(s) {
 	return s.toString().split('&').join('&amp;').split('<').join('&lt;').split('>').join('&gt;').split('"').join('&quot;').split('\'').join('&#039;');
 }
 
-/** @namespace */
+/** @namespace OCP */
 var OCP = {},
+	/**
+	 * @namespace OC
+	 */
 	OC = {
 	PERMISSION_NONE:0,
 	PERMISSION_CREATE:4,
@@ -659,7 +662,7 @@ var OCP = {},
 	registerMenu: function($toggle, $menuEl, toggle, headerMenu) {
 		var self = this;
 		$menuEl.addClass('menu');
-		
+
 		// On link, the enter key trigger a click event
 		// Only use the click to avoid two fired events
 		$toggle.on($toggle.prop('tagName') === 'A'
@@ -1101,7 +1104,8 @@ OC.Notification={
 	getDefaultNotificationFunction: null,
 
 	/**
-	 * @type Array.<int> array of notification timers
+	 * @type Array<int>
+	 * @description array of notification timers
 	 */
 	notificationTimers: [],
 

core/js/login.js

@@ -9,6 +9,7 @@
 /**
  * @namespace
  * @memberOf OC
+ * @private
  */
 OC.Login = _.extend(OC.Login || {}, {
 	onLogin: function () {

core/js/shareitemmodel.js

@@ -80,7 +80,7 @@
 	 */
 	var ShareItemModel = OC.Backbone.Model.extend({
 		/**
-		 * @type share id of the link share, if applicable
+		 * share id of the link share, if applicable
 		 */
 		_linkShareId: null,
 

core/search/js/search.js

@@ -23,7 +23,8 @@
 	'use strict';
 
 	/**
-	 * @class OCA.Search
+	 * @class Search
+	 * @memberOf OCA
 	 *
 	 * The Search class manages a search
 	 *