v0.0.3

compodoc · Nov 8, 2016 · 995696e · 995696e
1 parent 35f2cc5
commit 995696e
Show file tree

Hide file tree

Showing 4 changed files with 77 additions and 15 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,3 +1,15 @@
+<a name="0.0.8"></a>
+## 0.0.3 (2016-11-08)
+
+### Bug Fixes
+
+* **app:** title argument ([4b37cf2](https://github.com/groupe-sii/compodoc/commit/4b37cf2))
+* **app:** css for menu, scroll bounce, mobile main height ([839a49a](https://github.com/groupe-sii/compodoc/commit/839a49a))
+
+### Features
+
+* **app:** simple classes support ([35f2cc5](https://github.com/groupe-sii/compodoc/commit/35f2cc5))
+
 <a name="0.0.2"></a>
 ## 0.0.2 (2016-11-07)
 

diff --git a/README.md b/README.md
@@ -80,8 +80,8 @@ Because we doesn't find our needs on existing tools. We want to have a single pl
 
 - [ ] handle external markdown files as "functional" documentation
 - [ ] routes
-- [ ] classes
 - [ ] support for Angular 1.5+ projects written in Typescript
+- [x] classes
 - [x] module(s) page(s) with comments
 - [x] component(s) page(s) with comments, API, class
 - [x] directives

diff --git a/dist/index.js b/dist/index.js
@@ -200,6 +200,8 @@ class HtmlEngine {
             'injectable',
             'pipes',
             'pipe',
+            'classes',
+            'class',
             'routes'
         ], i = 0, len = partials.length, loop = (resolve$$1, reject) => {
             if (i <= len - 1) {
@@ -313,6 +315,7 @@ class DependenciesEngine {
         this.injectables = _.sortBy(this.rawData.injectables, ['name']);
         this.routes = _.sortBy(this.rawData.routes, ['name']);
         this.pipes = _.sortBy(this.rawData.pipes, ['name']);
+        this.classes = _.sortBy(this.rawData.classes, ['name']);
     }
     getModules() {
         return this.modules;
@@ -332,6 +335,9 @@ class DependenciesEngine {
     getPipes() {
         return this.pipes;
     }
+    getClasses() {
+        return this.classes;
+    }
 }
 
 class NgdEngine {
@@ -464,7 +470,8 @@ class Dependencies {
             'injectables': [],
             'pipes': [],
             'directives': [],
-            'routes': []
+            'routes': [],
+            'classes': []
         };
         let sourceFiles = this.program.getSourceFiles() || [];
         sourceFiles.map((file) => {
@@ -486,13 +493,13 @@ class Dependencies {
     }
     getSourceFileDecorators(srcFile, outputSymbols) {
         ts.forEachChild(srcFile, (node) => {
+            let deps = {};
+            let file = srcFile.fileName.replace(process.cwd() + path.sep, '');
             if (node.decorators) {
                 let visitNode = (visitedNode, index) => {
-                    let name = this.getSymboleName(node);
-                    let deps = {};
                     let metadata = node.decorators.pop();
+                    let name = this.getSymboleName(node);
                     let props = this.findProps(visitedNode);
-                    let file = srcFile.fileName.replace(process.cwd() + path.sep, '');
                     let IO = this.getComponentIO(file);
                     if (this.isModule(metadata)) {
                         deps = {
@@ -584,6 +591,21 @@ class Dependencies {
                     .forEach(visitNode);
             }
             else {
+                if (node.symbol) {
+                    if (node.symbol.flags === ts.SymbolFlags.Class) {
+                        let name = this.getSymboleName(node);
+                        let IO = this.getComponentIO(file);
+                        deps = {
+                            name,
+                            file: file,
+                            type: 'class',
+                            description: this.breakLines(IO.description),
+                            properties: IO.properties,
+                            methods: IO.methods
+                        };
+                        outputSymbols['classes'].push(deps);
+                    }
+                }
             }
         });
     }
@@ -1241,10 +1263,21 @@ var Application;
         $dependenciesEngine = new DependenciesEngine(dependenciesData);
         prepareModules();
         prepareComponents();
-        prepareDirectives();
-        prepareInjectables();
-        prepareRoutes();
-        preparePipes();
+        if ($dependenciesEngine.directives.length > 0) {
+            prepareDirectives();
+        }
+        if ($dependenciesEngine.injectables.length > 0) {
+            prepareInjectables();
+        }
+        if ($dependenciesEngine.routes.length > 0) {
+            prepareRoutes();
+        }
+        if ($dependenciesEngine.pipes.length > 0) {
+            preparePipes();
+        }
+        if ($dependenciesEngine.classes.length > 0) {
+            prepareClasses();
+        }
         processPages();
     };
     let prepareModules = () => {
@@ -1281,6 +1314,23 @@ var Application;
             });
         }
     };
+    let prepareClasses = () => {
+        logger.info('Prepare classes');
+        $configuration.mainData.classes = $dependenciesEngine.getClasses();
+        $configuration.addPage({
+            name: 'classes',
+            context: 'classes'
+        });
+        let i = 0, len = $configuration.mainData.classes.length;
+        for (i; i < len; i++) {
+            $configuration.addPage({
+                path: 'classes',
+                name: $configuration.mainData.classes[i].name,
+                context: 'class',
+                class: $configuration.mainData.classes[i]
+            });
+        }
+    };
     let prepareComponents = () => {
         logger.info('Prepare components');
         $configuration.mainData.components = $dependenciesEngine.getComponents();
@@ -1341,14 +1391,14 @@ var Application;
         });
         /*
         let i = 0,
-            len = $configuration.mainData.injectables.length;
+            len = $configuration.mainData.routes.length;
 
         for(i; i<len; i++) {
             $configuration.addPage({
-                path: 'injectables',
-                name: $configuration.mainData.injectables[i].name,
-                context: 'injectable',
-                injectable: $configuration.mainData.injectables[i]
+                path: 'routes',
+                name: $configuration.mainData.routes[i].name,
+                context: 'route',
+                route: $configuration.mainData.routes[i]
             });
         }*/
     };

diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "compodoc",
-  "version": "0.0.2",
+  "version": "0.0.3",
   "description": "The missing documentation tool for your Angular 2 application",
   "main": "index.js",
   "bin": {