Added index to ngXosLib documentation
Change-Id: Idee78870216616e84e4a3c40f66e1e19ef38ef2c
diff --git a/views/ngXosLib/gulp/ngXosHelpers.js b/views/ngXosLib/gulp/ngXosHelpers.js
index a19d85e..3d935e0 100644
--- a/views/ngXosLib/gulp/ngXosHelpers.js
+++ b/views/ngXosLib/gulp/ngXosHelpers.js
@@ -78,11 +78,11 @@
],
html5Mode: false,
title: 'XOS Helpers documentation',
- startPage: '/module',
+ startPage: '/ngXosLib',
}
return gulpDocs.sections({
- module: {
+ ngXosLib: {
glob: [
options.xosHelperSource + '*.js',
options.xosHelperSource + 'services/helpers/**/*.js',
@@ -116,7 +116,7 @@
gulp.task('docs', ['makeDocs', 'serveDocs'], function(){
var files = [
- options.xosHelperSource + '**/*.js'
+ options.xosHelperSource + '**/*.js',
];
gulp.watch(files, ['makeDocs']);
diff --git a/views/ngXosLib/xosHelpers/src/index.ngdoc.js b/views/ngXosLib/xosHelpers/src/index.ngdoc.js
new file mode 100644
index 0000000..c147763
--- /dev/null
+++ b/views/ngXosLib/xosHelpers/src/index.ngdoc.js
@@ -0,0 +1,11 @@
+/**
+* @ngdoc overview
+* @name ngXosLib
+* @id index
+* @description
+* # Welcome to the ngXosLib documentation! <br/>
+* This is the module that group all the helpers service and UI components for XOS.
+* <br/><br/>
+* You can find all the documentation related to the UI Component Library here: <a href="#/module/xos.uiComponents"> xos.uiComponents</a> <br/>
+* and the documentation related to all the other helpers here: <a href="#/module/xos.helpers"> xos.helpers</a> <br/>
+**/
\ No newline at end of file
diff --git a/views/ngXosLib/xosHelpers/src/ui_components/ui-components.module.js b/views/ngXosLib/xosHelpers/src/ui_components/ui-components.module.js
index d94e59d..f8bc222 100644
--- a/views/ngXosLib/xosHelpers/src/ui_components/ui-components.module.js
+++ b/views/ngXosLib/xosHelpers/src/ui_components/ui-components.module.js
@@ -13,7 +13,8 @@
* @ngdoc overview
* @name xos.uiComponents
* @description
- * A collection of UI components useful for Dashboard development.
+ * # xos.uiComponents
+ * A collection of UI components useful for Dashboard development. <br/>
* Currently available components are:
* - [xosAlert](/#/module/xos.uiComponents.directive:xosAlert)
* - [xosForm](/#/module/xos.uiComponents.directive:xosForm)
diff --git a/views/ngXosLib/xosHelpers/src/xosHelpers.module.js b/views/ngXosLib/xosHelpers/src/xosHelpers.module.js
index fb58015..9ec3f10 100644
--- a/views/ngXosLib/xosHelpers/src/xosHelpers.module.js
+++ b/views/ngXosLib/xosHelpers/src/xosHelpers.module.js
@@ -4,7 +4,17 @@
/**
* @ngdoc overview
* @name xos.helpers
- * @description this is the module that group all the helpers service and components for XOS
+ * @description
+ * # xos.Helpers
+ * A collection of helpers to work with XOS <br/>
+ * Currently available components are:
+ * - [NoHyperlinks](/#/module/xos.helpers.NoHyperlinks)
+ * - [SetCSRFToken](/#/module/xos.helpers.SetCSRFToken)
+ * - [xosNotification](/#/module/xos.helpers.xosNotification)
+ * - [XosUserPrefs](/#/module/xos.helpers.XosUserPrefs)
+ * <br/><br/>
+ * A set of angular [$resource](https://docs.angularjs.org/api/ngResource/service/$resource) is provided to work with the API.<br>
+ * You can find the documentation [here](#/rest-api)
**/
angular