compodoc

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

MIT License

Downloads
1.5M
Stars
4K
Committers
86
View Code on GitHub Visit Website
Ecosystems: TypeScript, Angular, Markdown

Bot releases are hidden (Show)

compodoc - 1.1.5

Published by vogloblinsky about 6 years ago

Bug fixes

compodoc - 1.1.4

Published by vogloblinsky about 6 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
compodoc - 1.1.3

Published by vogloblinsky over 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
compodoc - 1.1.2

Published by vogloblinsky over 6 years ago

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

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
compodoc - 1.1.1

Published by vogloblinsky over 6 years ago

Bug fixes

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

Published by vogloblinsky over 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
compodoc - 1.0.9

Published by vogloblinsky over 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
compodoc - 1.0.8

Published by vogloblinsky over 6 years ago

Features

Bug Fixes

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

Published by vogloblinsky over 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
compodoc - 1.0.6

Published by vogloblinsky over 6 years ago

Features

Bug Fixes

compodoc - 1.0.5

Published by vogloblinsky almost 7 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
compodoc - 1.0.4

Published by vogloblinsky almost 7 years ago

Features

Bug Fixes

  • dependencies: decorators metadatas resolve with imports (a5a3027c), closes #94
  • dependencies: spread operator support for module metadatas (8e098086), closes #298
  • core: split disablePrivateOrInternalSupport (9e4222ed), closes #241 #271
compodoc - 1.0.3

Published by vogloblinsky almost 7 years ago

Features

  • generation: return a Promise (2792967), closes #4

Bug Fixes

  • configuration: missing properties (c55d2496)
  • process: correct listening of unhandledRejection & uncaughtException (a0c4f688)
compodoc - 1.0.2

Published by vogloblinsky almost 7 years ago

Main features :

  • export option : json and html, pdf coming soon
  • es6 accessors support

Features

Bug Fixes

  • interface: fix relative link for properties (4751f602), closes #311
  • menu: URLs for CHANGELOG, CONTRIBUTING, LICENSE in pages with depth = 1 (8de9a9f3), closes #328
  • dependencies: handling QualifiedName types ex: Highcharts.Options (6bdd6345), closes #335
  • coverage: correctly ignore private members
    (19d8e5c2), closes #332
  • dependencies: namespace support
    (46e3601f), closes #341
  • cli: use tsconfig include attribute
    (69fa771c), closes #307
  • coverage: restore very-good status
    (37d1965c), closes #309
compodoc - 1.0.1

Published by vogloblinsky about 7 years ago

Stopping beta period. The release cycle will be more quicker than before, when between 5 to 10 bugs are ready to ship, i will submit a new patch version.

Features

  • coverage: Sort coverage table (30923878), closes #292
  • link: anchor support for @link (d9b75567), closes #211
  • pages: anchor for name of variables and functions (d9869a6f)

Bug Fixes

  • deps: support self-defined type (104b82fa), closes #267
  • deps: Array of custom interface not showing in documentation (469f0945), closes #300
  • deps: decorator with simple argument string (8eb13c52), closes #299
  • doc: links to Angular documentation for modules import, export etc (b9b9d419), closes #297
compodoc - 1.0.0-beta.15

Published by vogloblinsky about 7 years ago

Changes

  • main graph for huge projects with more than 200 modules is disabled, and viz.js error catched.
  • @HostBinding & @HostListener support

Features

Bug Fixes

  • symbols: lock icon just for private or protected (884eb9f), closes #291
  • deps: invalid provider config (77cc525), closes #293
  • deps: extends for interfaces (8ba84a8), closes #281
  • graph: Not able to generate graph on large projects (9ee7775), closes #283
  • output: absolute path in cwd (97953e3), closes #279
  • deps: return with union type & null (b7d3406), closes #287
  • deps: JSDoc tag for property in constructor (b8965f6), closes #286
  • deps: support typealias with LiteralType (8c284e7), closes #285
  • cli: Error with watch flag (ae727ec), closes #284
  • deps: support class with custom decorator (059b3c9), closes #245
compodoc - 1.0.0-beta.14

Published by vogloblinsky about 7 years ago

Changes

  • main graph for huge projects with more than 200 modules is disabled
  • index for functions, variables, inputs etc
  • speed parsing for huge projects

Bug Fixes

  • additional-doc: incorrect filenames in additional-documentation (68f80c60), closes #228
  • chore: -d + absolute folder (2830c086), closes #235
  • modules: Empty NgModule produce an empty graph (d6d8388b), closes #236
  • routes: iOS 8 routes graph rendering - innerHTML + SVG (128d33a1), closes #229
  • links: Url for @link is not always right (6be60bcb), closes #237
  • links: Wrong URL generated for inline {@link} doc in constructor (73285b51), closes #264
  • graph: render again in sequence (75ea0c96), closes #238
  • routes: Routes page not working with null route (a62e7487), closes #201
  • parsing: files scanning rewritten, huge main graph disabled (cd03eddf), closes #226 #231
  • overview: don't display empty graph if no modules (8c1ffe3b)
  • markdown: Images in README rendered in block (7c695473), closes #261
  • opts: disablePrivateOrInternalSupport public methods in component (a897a191), closes #265
  • templates: html tag bcode not balanced (8d96a5aa), closes #276
  • deps: UTF8-BOM parsing (3f4707cb), closes #230
  • deps: live-server issue with Node.js 8 (38710eaa), closes #232
  • deps: empty module decorator (00889ab6), closes #248
  • deps: component @param missing in the generated documentation (5b94056d), closes #225
  • deps: @example for functions (6b3f262c), closes #253
  • deps: c-style typed arrays support (91f23f38), closes #256
  • deps: indexable for class (a12c120f), closes #255
  • deps: coverage and constructor properties (0653fb23), closes #259
  • deps: inherit return type (d468ee8d), closes #268
  • deps: support class with custom decorator (059b3c9e), closes #245

Features

  • app: display link to MDN or TypeScript doc for basic types (1cfa58e2)
  • app: better params display (0fb9e93c)
  • deps: support of function type parameter (e8b1c0fd)
  • deps: link to enums, split misc pages (37ec7ba4), closes #266
  • deps: @internal for main class decorator (bafc1878), closes #262
  • deps: Override JSDOC params types with TypeScript ones (7492c45a), closes #254
compodoc - 1.0.0-beta.13

Published by vogloblinsky over 7 years ago

Bug Fixes

  • deps: Resolve array declaration in modules (619842d), closes #210 #15
  • routes: Routes names required to be unique (7f17ecb), closes #193
  • deps: RangeError: Invalid array length / @input/@output parsing (048fd20), closes #209
  • html: Type in "Infos" tab - should be "Info" (1ceee52), closes #224
  • html: Source code not rendered (bfe4708), closes #223

Features

  • chore: Add an interactive examples tab (34de4f0), closes #188 Thanks rprotsyk.
  • doc: support to display the changelog.md, contributing, license, todo (272a0ad), closes #215
  • watch: Watch README.md, and other root markdown files (ed05424), closes #221
  • chore: Markdown file support for modules, services, etc (918a521), closes #204
compodoc - 1.0.0-beta.12

Published by vogloblinsky over 7 years ago

Bug Fixes

  • chore: Cannot find module 'json5' (04fb75f), closes #219
  • dependencies: All types display in the doc as void (incorrect types) (c586b32), closes #218
compodoc - 1.0.0-beta.11

Published by vogloblinsky over 7 years ago

Bug Fixes

  • options: Link correct options with CLI flags (82af585), closes #205
  • watch: Watch mode not working properly (4264b5e), closes #141
  • search-engine: Invalid JSON is creating an issue when rendering the object to the template (8042af5), closes #187
  • routes: Trailing commas throw error when parsing routes (7bc1e05), closes #192 #173
  • misc: Miscellaneous sections Functions not showing documentation (235f1d0), closes #142
  • deps: add @default support (78257cc), closes #212
  • deps: Bespoke types and Promise being converted to any type in output documentation (35af038), closes #208
  • output: Linux unix like environments: Absolute paths generates fonts, images, js and styles in the wrong directory (e0a3c60), closes #206

Features

  • log: add more logs on silent mode (1c858c7)
  • chore: run files generation in // +20% in speed generation 🎉 (832b20d)
Package Rankings
Top 0.68% on Npmjs.org
Top 23.14% on Repo1.maven.org
Badges
Extracted from project README
Backers Sponsors
Related Projects
angular-starter

Angular 18 Starter with Storybook, Transloco, Jest, Cypress, Docker, ESLint, Material & Prettier

14 May 2020 271
hello-worlds

Hello world apps for angular, react, svelte, and vue

09 Apr 2020 128
vuesion

Vuesion is a boilerplate that helps product teams build faster than ever with fewer headaches and...

18 Nov 2017 2,767