compodoc

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

MIT License

Downloads
1.5M
Stars
4K
Committers
86

Bot releases are hidden (Show)

compodoc - 1.0.0-beta.10

Published by vogloblinsky over 7 years ago

Bug Fixes

  • menu: Make the entire list item clickable for a section toggle (4f4c1f5), closes #194
  • chore: kind icon issue for properties and functions (4b9f496)
  • menu: Navigation: clicking on a sub element (page) inside the expandable category expands all categories (86ac1b4), closes #186
  • markdown: At sign replaced by a brace in markdown code blocks (41c6b0d), closes #189
  • dependencies: Multiple classes in the same file get the same description (8a679f0), closes #118
  • exclude: Not able to exclude files from documentation (a88023c), closes #175
  • source: Hide some elements if source code is disabled (0e81c15), closes #185
  • badge: Documentation coverage badge size should match common badges (21f5abe), closes #200
  • dependencies: Interface generation missing w/o errors. (2b7d4e7), closes #198
  • dependencies: Please Support @private JSDoc. (6c7ce67), closes #183
  • comments: Newline markdown (74f64d2), closes #195

Features

  • version Detect angular version and link to the correct version of the documentation (f270af7), closes #180
  • dependencies: Parsing refactoring, huge speed boost +75% ! (65744ed)
compodoc - 1.0.0-beta.9

Published by vogloblinsky over 7 years ago

Bug Fixes

  • markdown Fix escaping of html entities in code blocks (e816cbe), thanks Thomas Mair
  • config Allow for comments in tsconfig.json (2796de5), closes #177
  • chore Problem with resources file when providing absolute output path (b52a40e7), closes #176
  • watch Watch for additional doc too (52801f4b), closes #163
  • dependencies decorators support (65bbabc7), closes #171
  • markdown Set marked break option to false (0e6ac342), closes #181
  • dependencies UTF8 Bom support (a3d5bec7), closes #170

Features

  • app exclude with glob patterns (6310735), closes #174
  • cli display Node.js and OS infos after banner (c0f60561)
compodoc - 1.0.0-beta.8

Published by vogloblinsky over 7 years ago

Bug Fixes

  • dependencies: custom decorators breaks (50578ec), closes #169
  • UI: Open menu when item selected (70d38c7), closes #168
  • graph: No Declarations or Providers being added to module graphs (bf776f4), closes #167

Features

  • files: Better error reporting for template file reading (6f2d783)
compodoc - 1.0.0-beta.7

Published by vogloblinsky over 7 years ago

Bug Fixes

  • overview: Main overview graph is shifted on right side (8fe238d), closes #166
compodoc - 1.0.0-beta.6

Published by vogloblinsky over 7 years ago

Bug Fixes

  • dependencies: Unhandled promise rejection with "use strict" (f56c01a), closes #165
  • links: Interface Linking is wrong (152c722), closes #157

Features

  • component: Expand on the Readme.md for component to use component.md (actual name of component) (c246ffb), closes #164
  • coverage: Coverage test command (e15f238), closes #156
compodoc - 1.0.0-beta.5

Published by vogloblinsky over 7 years ago

Bug Fixes

  • modules: module graph controls JS error with file:// (6d4be23), closes #153 #159
  • component: custom treatment of the metadata field template (1bbda74), closes #137
  • component: loading template from another component fails (1bbda74), closes #147
compodoc - 1.0.0-beta.4

Published by vogloblinsky over 7 years ago

Bug Fixes

  • directives: "Implements" support for directives. (6138070), closes #155
  • links: Link to "Getting started" / "README" should be ./index.html (8d30fd9), closes #158
  • dependencies: Main modules graph seems too confuse (ef7b04f), closes #150

Features

  • app: Link directly to the README of a component (3636ce3), closes #154
compodoc - 1.0.0-beta.3

Published by vogloblinsky over 7 years ago

Bug Fixes

  • coverage: Documentation coverage issue. (a01ee06), closes #143
  • search: Search links are broken. (e81a0f7), closes #140
compodoc -

Published by vogloblinsky over 7 years ago

Bug Fixes

  • dom-tree: Unable to view DOMTree nodes image correctly. (2b5f275), closes #143
  • app: Links are broken for static doc. (da2e18e), closes #140

Features

  • app: toggleMenuItems for additionalPages (692cfa0)
compodoc - 0.0.41

Published by vogloblinsky over 7 years ago

Bug Fixes

  • app: remove TypeScript dependency for JSDoc tags (3a30eb7)
  • app: jsdoc tag example for component decorator (786aea2), closes #100, #90
  • app: UnhandledPromiseRejectionWarning (e9fdea5), closes #100, #103

Features

  • app @example for pipe, component and directive decorators (706322d)
compodoc - 1.0.0-beta.1

Published by vogloblinsky over 7 years ago

Breaking changes

  • @compodoc/compodoc : move compodoc to @compodoc/compodoc

Features

  • app: add component DOM tree graph in tab (318d0c6), closes #108
  • app: add outlet routes detail, cleaning (a859976)
  • app: additional documentation support (8792b3a)
  • app: component DOM tree clickable and link to known components (ea5df1e)
  • app: details on unique names for routes (6d0df01)
  • app: display lazy-loaded modules infos / WIP (5bc21dc)
  • app: link component DOM tree with directives founded (3a8010a)
  • app: misc type first support (1db6781)
  • app: move to prism.js for syntax highlighting + "Defined in" link (c252d6e)
  • app: new routes page (169730a), closes #39 #17
  • app: routes guards (aa27e65)
  • app: routes page with modules support (1a6a390)
  • app: templateUrl file read (53ceeb8)
  • app: toggleMenuItems option (52891da)
  • app: watch flag (dbe7cb6), closes #20
  • app: watch flag | add/remove support (a276dac), closes #20
  • menu: display routes after all general items (09a1caf)
  • routing: display lazy loading routes (075670e)
  • routing: display routes length in overview (a713aec)

Bug Fixes

  • app: @link parsing (55564d6)
  • app: add support for inheritanceand extends (97cff59), closes #116
  • app: components don't have the correct data depth (b6f20e5), closes #111
  • app: doesn't display routes pages if no routes (d31d634)
  • app: functionSignature args 0 (d93a39d)
  • app: group misc by file, support of enums (8031223), closes #101
  • app: menu modules page link (f92f871)
  • app: Multiple classes in the same file get the same description (516ce47), closes #118
  • app: node 4 spread support (aa53770)
  • app: promise sequential & node 4 (354c0df)
  • app: Promise TS support (8eeccb9)
  • app: Recognize ngOnInit() as a method | Angular Lifecycle hooks (2f0d5c0), closes #114
  • app: support of functions (fe4ecf8), closes #110
  • app: syntax highlightning / themes (0822550), closes #123
  • app: watch changed file strategy details (3544cd9)
  • dependencies: visitType error (be6258d), closes #103
  • doc-coverage: ignore private, handle constructor (d4b7274), closes #122
  • misc: display file path (8cd7a2e), closes #101
  • routes: handle no lazy module (aa85c63)
compodoc - 0.0.40

Published by vogloblinsky over 7 years ago

Bug Fixes

  • app: ts.getJSDocTags availability (b3af872), closes #104, #105
  • app: exclude part of the project from documentation generation (a7374a9), closes #102
compodoc - 0.0.39

Published by vogloblinsky over 7 years ago

Bug Fixes

  • app: Private methods and properties are skipped / align to typedoc (8490983), closes #99
  • app: @link does not seem to be getting parsed for properties (d1fd592), closes #98
  • app: support indexable object (cceb933), closes #97
  • app: Support @internal in the module level as well (750cd63), closes #87
  • app: miscellaneous support | variables and functions (d758840), closes #55
  • app: remove base html tag, file:// support (0e5227d), closes #47 #35

Features

  • app: move to @compodoc/ngd (311facb)
  • app: disablePrivateOrInternalSupport flag (294d4e2)

Breaking changes

  • base tag removed. The documentation can now be opened directly with a browser.
compodoc - 0.0.38

Published by vogloblinsky over 7 years ago

Bug Fixes

  • app: ngd call for output path with spaces (37fe0a6), closes #44
  • app: class constructor test (54b7c8e), closes #95
  • app: test if constructor available (bd1cb92)
compodoc - 0.0.36

Published by vogloblinsky over 7 years ago

Bug Fixes

  • app: differentiate static members from instance members (c8460eb), closes #88
  • app: modules menu items shows even if no modules (af72453), closes #89
  • app: Image should resize to fit viewport (2b24237), closes #83
  • app: @input without type (0f92ca4)
  • app: file parsed doesn't exist (eda183d)
  • app: interface keys sorting with [key: string]: string; (4e4c5cd)
  • app: component output type issue with NewExpression (4e49d22)
  • app: parsing .d.ts (e38b571)
compodoc - 0.0.37

Published by vogloblinsky over 7 years ago

Features

  • app: extend directive documentation (1637178), closes #91
  • app: Support for @example from JSDoc (51cd282), closes #90
  • app: Support for @link from JSDoc (f05b7e7), closes #92
  • app: include constructor method in docs (ddd00dc), closes #94
compodoc - 0.0.35

Published by vogloblinsky over 7 years ago

Bug Fixes

  • app: multi-line in description and code hightlight in jsdocs params (816027e), closes #79 #77 #76
  • app: coverage report breaks (462cf95), closes #65 #80
  • app: dont link to files excluded via tsconfig (3063f10), closes #59

Features

  • app: show component output $event type (fa894f0), closes #60
compodoc - 0.0.3

Published by vogloblinsky over 7 years ago

Bug Fixes

  • app: title argument (4b37cf2)
  • app: css for menu, scroll bounce, mobile main height (839a49a)

Features

  • app: simple classes support (35f2cc5)
compodoc - 0.0.34

Published by vogloblinsky almost 8 years ago

Bug Fixes

  • app: nvm or nodejs / windows support (0512c899), closes #44

Features

  • app: support external assets folder (90ba24d), closes #71
compodoc - 0.0.33

Published by vogloblinsky almost 8 years ago

Bug Fixes

  • app: handle path with spaces for ngd call (8037285), closes #44
  • app: nvm-windows path issue (7ac7373), closes #65
  • app: disable highlightjs line-numbers on bash code blocks (96a6ff4), closes #64
  • app: Cannot read property 'configuration' of undefined during external theme copy (2127408), closes #69

Features