Merge pull request #3 from estellepicq/documentation

New documentation with typedoc
LCluber · Jul 5, 2018 · 4f08925 · 4f08925
2 parents 05451f1 + 449ebd0
commit 4f08925
Show file tree

Hide file tree

Showing 21 changed files with 2,451 additions and 88 deletions.
diff --git a/RELEASE_NOTES.md → CHANGELOG.md b/RELEASE_NOTES.md → CHANGELOG.md
@@ -1,24 +1,32 @@
-Version 0.2.2 (April 28th 2018)
------------------------------
- * Added Wee.js utility library
-
-Version 0.2.1 (March 19th 2018)
------------------------------
- * Added logs with Mouette.js
- * Added TypeScript Declaration File
-
-Version 0.2.0 (January 1st 2018)
------------------------------
- * Added setInput() method to the Keyboard class.
- * Added getLastLog() method to the Keyboard class.
- * Logged all kind of errors that can occur during the addInput or setInput processes.
- * An input object does not have a name anymore.
- * Library is written in TypeScript
-
-Version 0.1.1 (October 28th 2017)
------------------------------
- * The 'addInput()' method of the 'Keyboard' class can now receive an ASCII code or a string as parameter. The string will then be converted as a valid ASCII code.
-
-Version 0.1.0 (August 25th 2017)
------------------------------
- * initial version
+Version 0.2.3 (July 4th 2018)
+------------------------------
+ * Documentation automatically generated in /doc folder
+ * Typedoc and grunt-typedoc added in devDependencies
+ * New "typedoc" task in Gruntfile.js
+ * Typescript upgraded to version 2.9.2
+ * INSTALL.md becomes NOTICE.md and RELEASE_NOTES.md becomes CHANGELOG.md
+
+Version 0.2.2 (April 28th 2018)
+-----------------------------
+ * Added Wee.js utility library
+
+Version 0.2.1 (March 19th 2018)
+-----------------------------
+ * Added logs with Mouette.js
+ * Added TypeScript Declaration File
+
+Version 0.2.0 (January 1st 2018)
+-----------------------------
+ * Added setInput() method to the Keyboard class.
+ * Added getLastLog() method to the Keyboard class.
+ * Logged all kind of errors that can occur during the addInput or setInput processes.
+ * An input object does not have a name anymore.
+ * Library is written in TypeScript
+
+Version 0.1.1 (October 28th 2017)
+-----------------------------
+ * The 'addInput()' method of the 'Keyboard' class can now receive an ASCII code or a string as parameter. The string will then be converted as a valid ASCII code.
+
+Version 0.1.0 (August 25th 2017)
+-----------------------------
+ * initial version
diff --git a/Gruntfile.js b/Gruntfile.js
@@ -64,6 +64,10 @@ module.exports = function(grunt){
                 compiledSrcDir + '*'
               ]
       },
+      doc:{
+        src: [  docDir + '*'
+              ]
+      },
       web:{
         src: [  zipDir + '*',
                 webDir + 'static/*',
@@ -78,6 +82,16 @@ module.exports = function(grunt){
         ]
       }
     },
+    typedoc: {
+  		build: {
+  			options: {
+  				out: docDir,
+  				target: 'es6',
+          name: projectName + '.js - Documentation'
+  			},
+  			src: [srcDir + 'ts/*.ts']
+  		}
+  	},
     jshint: {
       options: {
         jshintrc: 'config/.jshintrc'
@@ -501,6 +515,7 @@ module.exports = function(grunt){
   grunt.loadNpmTasks( 'grunt-tslint' );
   grunt.loadNpmTasks( 'grunt-ts' );
   grunt.loadNpmTasks( 'grunt-rollup' );
+  grunt.loadNpmTasks( 'grunt-typedoc' );
 
   grunt.registerTask( 'lib',
                       'build the library in the dist/ folder',
@@ -516,8 +531,10 @@ module.exports = function(grunt){
                     );
 
   grunt.registerTask( 'doc',
-                      'build jsdoc in the doc/ folder',
-                      [ 'jsdoc' ]
+                      'Compile lib documentation',
+                      [ 'clean:doc',
+                        'typedoc'
+                      ]
                     );
 
   // grunt.registerTask( 'static',
@@ -568,6 +585,8 @@ module.exports = function(grunt){
                         grunt.task.run('lib');
                         //build site
                         grunt.task.run('website');
+                        //build documentation
+                        grunt.task.run('doc');
                       }
                     );
 

diff --git a/INSTALL.md → NOTICE.md b/INSTALL.md → NOTICE.md
@@ -1,54 +1,55 @@
-## Krait.js project installation guide
-
-You just cloned Krait.js : git clone https://github.com/LCluber/Krait.js.git
-
-### Install nodejs 4 on your server :
-  - Windows and OSX : **https://nodejs.org/en/**
-  - Linux master race : run
-    - **curl -sL https://deb.nodesource.com/setup_4.x | sudo -E bash -**
-    - **sudo apt-get install -y nodejs**
-
-
-### Install bower :
-  - Run **npm install -g bower**
-
-
-### Install ruby :
-  - Windows : **http://rubyinstaller.org/downloads/**
-  - OSX : already installed
-  - Linux master race : run **sudo apt-get install ruby-full**
-
-
-### Install sass :
-  - Run **gem install sass**
-
-
-### Install grunt :
-  - Run **npm update -g npm** to update npm
-  - Run **npm install -g grunt-cli**
-
-
-### Install project dependencies
-  - Run **npm install** in your project directory
-
-
-### Workflow
-  - Use **grunt --help** to see the list of tasks.
-  - Run **grunt** build library, website, launch server, open website and watch for changes.
-
-  - You can use those commands to build specific parts :
-    - **grunt doc** build the documentation in the doc/ folder,
-    - **grunt lib** build the library in the dist/ folder and the documentation in the doc/ folder,
-    - **grunt website** build the website in the website/ folder,
-    - **grunt dist** build library and website,
-    - **grunt serve** launch server, open website and watch for changes,
-    - Start Express server manually :
-      - Windows : Run **set DEBUG=Kraitjs:* & npm start**
-      - Linux / OSX : Run **DEBUG=Kraitjs:* npm start**
-    - Go to **http://localhost:3008/** to test the app.
-    - Keep in mind running **grunt** once will do all this automatically.
-
-
-  - Set node environment if needed : 
-    - Run **export NODE_ENV=development**
-    - Or **export NODE_ENV=production**
+## Krait.js project installation guide
+
+You just cloned Krait.js : git clone https://github.com/LCluber/Krait.js.git
+
+### Install nodejs 4 on your server :
+  - Windows and OSX : **https://nodejs.org/en/**
+  - Linux master race : run
+    - **curl -sL https://deb.nodesource.com/setup_4.x | sudo -E bash -**
+    - **sudo apt-get install -y nodejs**
+
+
+### Install bower :
+  - Run **npm install -g bower**
+
+
+### Install ruby :
+  - Windows : **http://rubyinstaller.org/downloads/**
+  - OSX : already installed
+  - Linux master race : run **sudo apt-get install ruby-full**
+
+
+### Install sass :
+  - Run **gem install sass**
+
+
+### Install grunt :
+  - Run **npm update -g npm** to update npm
+  - Run **npm install -g grunt-cli**
+
+
+### Install project dependencies
+  - Run **npm install** in your project directory
+  - Run **bower install** from your project directory
+
+
+### Workflow
+  - Use **grunt --help** to see the list of tasks.
+  - Run **grunt** build library, website, launch server, open website and watch for changes.
+
+  - You can use those commands to build specific parts :
+    - **grunt doc** build the documentation in the doc/ folder,
+    - **grunt lib** build the library in the dist/ folder and the documentation in the doc/ folder,
+    - **grunt website** build the website in the website/ folder,
+    - **grunt dist** build library and website,
+    - **grunt serve** launch server, open website and watch for changes,
+    - Start Express server manually :
+      - Windows : Run **set DEBUG=Kraitjs:* & npm start**
+      - Linux / OSX : Run **DEBUG=Kraitjs:* npm start**
+    - Go to **http://localhost:3008/** to test the app.
+    - Keep in mind running **grunt** once will do all this automatically.
+
+
+  - Set node environment if needed :
+    - Run **export NODE_ENV=development**
+    - Or **export NODE_ENV=production**
diff --git a/README.md b/README.md
@@ -25,7 +25,7 @@ No tests to run yet
 ## Contributors
 
 There is still a lot of work to do on this project and I would be glad to get all the help you can provide.
-To contribute you can clone the project on **[GitHub](https://github.com/LCluber/Krait.js)** and see  **INSTALL.md** for detailed installation walkthrough of the project.
+To contribute you can clone the project on **[GitHub](https://github.com/LCluber/Krait.js)** and see  **NOTICE.md** for detailed installation walkthrough of the project.
 
 ## License