Compodoc Versions Save

:notebook_with_decorative_cover: The missing documentation tool for your Angular, Nest & Stencil application

1.1.4

5 years ago

Features

Improvements

Bug fixes

  • CLI: JSON Configuration File JSON Schema (d8e48d57), closes #577
  • CLI: handle ../ in includes in tsconfig includes/excludes (4a445050), closes #596
  • UI: Address double scrollbar on example tabs for directive, pipe, and injectable (81e33988) Thanks Blake Simmon
  • UI: move to ionicons (f81b42ec), closes #592
  • UI: Accessors section in top index pages (aa4a4929), closes #615
  • menu: overview href is generated twice (5479515a), closes #575
  • deps: barrel file support for import finding strategy (780c0653), closes #566
  • deps: interfaces with custom names (78c59ea1), closes #580
  • deps: duplicates for more than 2 files (bf6e9238), closes #590
  • deps: Duplicate pages for injectables with custom decorators (80417826), closes #591
  • deps: generic support for Map<K, V> (8f3ef941), closes #622
  • deps: abstract modifier (1e6eecba), closes #626
  • graph: special character in module name (00075366), closes #591

1.1.3

6 years ago

Features

  • UI: disableTemplateTab flag (fed52f1), closes #545
  • config: add config management support with custom file (bd249fb), closes #379
  • UI Add ability to specify tab ordering and custom tab labels (e1bdc2e), closes #522 Thanks Blake Simmon

Bug fixes

  • CLI: Uniqid for entities between two documentation generation (1ce6543), closes #550
  • CLI: absolute path with d flag (f86f11b), closes #559
  • CLI: exclude parser with duplicate file names (568af47), closes #551
  • CLI: Using absolute path for -p/--tsconfig (7d8566c), closes #558
  • menu: Navigation is broken with watch mode (616e469), closes #548
  • UI: sort modules import/exports/declarations/providers in ascending order (9449574), closes #538
  • UI: back button handling (b5e16e8), closes #557
  • UI: additional url + regular entity (3464b0c), closes #554
  • UI: ensure examples tab has only one scrollbar (d60b406), closes #562 Thanks Blake Simmon
  • deps: async functions documented with empty badge (3049781), closes #556
  • deps: modules spread elements with global variables (9576cc6), closes #494
  • deps: Generic array types support (0ad79de), closes #552
  • deps: generic type parameters for functions (db9167b), closes #555
  • deps: routing with bootstrapModule in if statement (19109ff), closes #560
  • deps: empty @example JSDoc tag (db48253), closes #543
  • deps: routes data with function call (ccc13ce), closes #525
  • deps: tuples types support (dc540c5), closes #540
  • deps: extendMerger (a7448c9), closes #542
  • deps: JSDoc param inside constructor (c01484c), closes #541
  • search: better results display + enable wildcards (43c6d5d), closes #537 #447
  • routing: routes without routing module (11a742c), closes #518 #488

1.1.2

6 years ago

Performance improvements of pages rendering | +20% in speed generation :tada:

Features

Bug fixes

  • app: Handlebars JavaScript heap out of memory (c8d29167), closes #521
  • theme: correct path if no README in root folder (78ceab38), closes #524
  • dependencies: coverage for file even with no hostlisteners for example (c7a32643), closes #527
  • dependencies: --disableLifeCycleHooks with @ignore on component/directive (eb9fddf2), closes #526
  • dependencies: replace callExpressions in routes definitions with text (2b22fa63), closes #525 #467
  • dependencies: module imports forRoot/forChild cleaning (3e473791), closes #531

1.1.1

6 years ago

Bug fixes

  • npm: uuid not in dependencies (bd1d20), closes #523

1.1.0

6 years ago

Main feature :

New menu organisation : components, directives or injectables of a module are displayed directly in the module menu entry

Main structural change :

Drop direct TypeScript dependency, Compodoc now relies on ts-simple-ast TypeScript dependency.

Features

  • UI: Component, directive, pipe and injectable not linked inside a module should appear in the menu alone (b0106382), closes #510
  • UI: Display filename in index of miscellaneous (4ddeda4f), closes #520
  • CLI: disableDomTree option (c71ca965), closes #517

Bug Fixes

  • UI: group components, directives, injectables, pipes based on module (46cbb07a), closes #145 #258
  • UI: Dependency-Link not shown in side-nav if no dependencies and peerDependencies (5ffe9d22), closes #506
  • dependencies: return's comment of method is missing (05cd3a4c), closes #512
  • dependencies: Display component providers (78045092), closes #514
  • dependencies: component inheritance with simple base class + disabledLifeCycleHooks support (bd940053), closes #505
  • dependencies: support entity with same name (01ac07a3), closes #474 #233

1.0.9

6 years ago

Features

  • dependencies: display peer dependencies in dependencies page (eece547f), closes #478
  • dependencies: inheritance support for components and classes (b94e9c75), closes #324 #152
  • dependencies: @ignore JSDoc tag support (98326bdf), closes #486
  • UI: Link to code line issue with multiple code blocks (aec0014a), closes #466

Bug Fixes

  • dependencies: Optional methods/property for TS interfaces/classes (a3ce87fc), closes #484
  • dependencies: union types with array (9b0be6dd), closes #496
  • dependencies: union types with generics (eec9c4be), closes #501
  • additional: external docs change sorting (646d7ecc), closes #471 #482
  • dependencies: multiple union types with array (182a1593), closes #498 #499

1.0.8

6 years ago

Features

Bug Fixes

  • jsdoc: @link for external url broken (6775ef), closes #305

1.0.7

6 years ago

Bug Fixes

  • accessors: Accessors not parsing all data correctly (80af63b), closes #468
  • routing: Routes not scanned for Node.js 7 & 6 (9435422), closes #463
  • templates: hide cells for function parameters if field is empty (5d32cbb), closes #464

1.0.6

6 years ago

Features

Bug Fixes

1.0.5

6 years ago

Features

  • code-highlightning: copy button (15ad139d), closes #373
  • dependencies: entryComponents support for modules (4774f9e3)

Bug Fixes

  • dependencies: accessors documentation (84857c2b), closes #393
  • dependencies: function parameter undefined in Miscellaneous - Functions (e29a56c8), closes #389
  • dependencies: Empty description for accessors (45181513), closes #385
  • dependencies: wrong generated links of module declarations (ab1af5b0), closes #372
  • dependencies: Dom tree tab - component with inline template (9ff83a90), closes #370
  • dependencies: static modifier (6cd80868), closes #367
  • dependencies: disableLifeCycleHooks ignored for Directives (c2b5f75f), closes #363
  • dependencies: dynamic import support for path and pathMatch routes definition (633ea2f8), closes #216
  • tabs: conflict with readme titles (230d96a6), closes #381
  • links: the generated href to angular api doc is wrong (153b38d9), closes #368
  • markdown: image tag not correctly closed (43c86a17), closes #384
  • coverage: add misc functions and variables (04e0c038), closes #388
  • routes: support for outlet dynamic imports, + enums (d3b9b9e9), closes #394
  • core: typescript errors (96426902), closes #369 Thanks daniel.preussner