Skip to content

Latest commit

 

History

History
545 lines (242 loc) · 24.6 KB

CHANGELOG.md

File metadata and controls

545 lines (242 loc) · 24.6 KB

Change Log

All notable changes to this project will be documented in this file. See Conventional Commits for commit guidelines.

4.11.0 (2022-08-03)

Bug Fixes

Features

4.10.3 (2021-03-09)

Bug Fixes

  • docgen: clean up extra __version field after typescript generator runs (e52f63a)
  • docgen: fix html and typescript format outputs, refactor generation code (1f3ff62)

4.10.2 (2021-03-09)

Bug Fixes

  • dont pretty print the jsca file (701d298)
  • some extendPageData generated path with duplicated versions (23fab6c)

4.10.1 (2021-01-12)

Bug Fixes

  • docgen: guard createable property for generated methods properly (04a29be)

4.10.0 (2020-11-19)

Bug Fixes

  • docgen: output optional/repeatable when true for method parameters in json-raw format (217c50f)

Features

  • docgen: support 'any' type (2f52fc3), closes #103
  • plugin-apidocs: improved method signature display (8b4f689), closes #105

4.9.3 (2020-11-19)

Bug Fixes

  • docgen: support references to builtin types when validating class names (9600a9f)

4.9.2 (2020-11-18)

Bug Fixes

  • docgen: skip Node.js shim docs for typescript generation (d0955fa)

4.9.1 (2020-11-12)

Bug Fixes

  • docgen: assertObjectKey needs to guard for null object (8b5f51d)

4.9.0 (2020-11-10)

Bug Fixes

  • fix color shades, sidebar sub groups and type meta padding (ffc5817)
  • properly handle falsy default values (9485406)
  • show type of constants (a632c4a)

Features

  • theme: custom color theme for prism.js (#83) (c826dc0)

4.8.3 (2020-10-21)

Bug Fixes

  • use axway theme gray-dk in place of hard-coded #aaa (7723256)
  • use named axway colors in place of hard-coded hex values (961cbb1)

4.8.2 (2020-10-19)

Bug Fixes

  • scroll behavior and css adjustments (c8cb639)
  • apidocs: mark constants as readonly (02ff95d)
  • apidocs: show property default value and related constants (b73996a)
  • theme: add axway color variables (df8c5b3)
  • theme: try to use axway typography values for headers (7fd1115)
  • theme: use axway blue colors for inline code tags (16bb3e5)
  • theme: use axway danger/success/warn colors for badges (a543d9c)
  • theme: use axway danger/success/warn colors for custom blocks (4a9cfe1)
  • theme: use page relativePath to generate edit link (#70) (ca0e1c2), closes #48

4.8.1 (2020-10-08)

Bug Fixes

  • docgen: better match git repo URIs, report bad via console (444d94f)

4.8.0 (2020-10-08)

Bug Fixes

Features

  • theme-titanium: allow frontmatter to contain editUrl for edit this page link (dd6a1e2)
  • titanium-docgen: include editUrl in json-raw output for types (5b0890c)

4.7.0 (2020-08-28)

Features

  • support macos (bc3462f)
  • docgen: Add more validations for since/deprecated, duplicated platform listings (b28357b)

4.6.1 (2020-07-22)

Bug Fixes

  • fontawesome: use scoped package name (4f34515)

4.6.0 (2020-07-21)

Bug Fixes

Features

4.5.2 (2020-06-23)

Performance Improvements

  • ssr: load type metadata on api pages only (c3b728a)

4.5.1 (2020-06-19)

Performance Improvements

  • docgen: don't include filename properties in json-raw output (#36) (0eca516)
  • docgen: don't include pretty_name in json-raw output (#34) (7e5decd)
  • cache page lookup (4c27c0f)

4.5.0 (2020-06-18)

Bug Fixes

  • mark all nested sidebar items active (fcc5312)
  • nested sidebars without path (62bacb1)
  • pass reactive data to ensure child component updates (1776df0)
  • sidebar css fixes (396ac84)

Features

  • support nested sidebars (1e28793)

4.4.1 (2020-06-12)

Bug Fixes

  • apidocs: handle no method parameters (b124c1d)
  • apidocs: handle when type metadata not found w/ no Error (a036e0d)
  • metadata: handle empty methods/properties/events on type (42ce5c8)

4.4.0 (2020-06-12)

Bug Fixes

  • docgen: avoid outputting null and empty array values to shrink output json (3908195)

Features

  • validate: warning for misxed case event names, split String vs ASCII validation (ed21978)

4.3.1 (2020-04-17)

Bug Fixes

  • docgen: allow unknown properties on ListDataItem (774051d)

4.3.0 (2020-03-05)

Bug Fixes

  • docgen: build correct path (#27) (2f085f0)
  • docgen: ts definition for Ti.Android.R (#31) (388df48)
  • docgen: use correct include syntax for ejs3 (e4dde5d)
  • docgen/modulehtml: correct require path (e00f175)

Features

  • docgen: improve typescript generator (#25) (34f07c5)
  • docgen: improved accessors deprecation generation (#24) (5981029)

4.2.0 (2020-02-05)

Features

  • docgen: accept whitelist of constants references to skip (#26) (3b1c537)

4.1.0 (2019-12-12)

Features

  • docgen: improve validation to include warnings (#21) (efe2aca)

4.0.1 (2019-12-11)

Note: Version bump only for package docs-devkit

4.0.0 (2019-12-02) [YANKED]

3.0.0 (2019-12-02) [YANKED]

2.0.0 (2019-12-02) [YANKED]

1.0.0 (2019-12-02)

Bug Fixes

  • apidocs: add platform availability icons (ece76c7)
  • apidocs: process metadata after markdown is completely initialized (3db479f)
  • apidocs: properly render method and event params (28109e6)
  • apidocs: replace state with correct structure during ssr (f2e3ed3)
  • apidocs: use markdown renderer return type (7e935e5)
  • apidocs: use type-links component instead of old custom formatter (8953f08)
  • docgen: add missing typescript generator changes (22d0779)
  • docgen: add missing validate command (807f211)
  • docgen: allow Error and RegExp as predefined types (#10) (428aedd)
  • docgen: correctly handle array syntax in callbacks (#3) (eb43ad5)
  • ios: do not show anchor links for top two level headings (c4b1497)
  • theme: add bottom padding to home page (6b2d0be)
  • theme: add default content class (d516092)
  • theme: apply latest theme-default (7b15292)
  • theme: guard against undefined paths (ed03520)
  • theme: height wrapper to avoid glitches (7923ded)
  • theme: mark versions dropdown as can-hide (eecb704)
  • theme: only show api sidebar button if page has api docs (06513cb)
  • theme: show footer only if configured (9d9f4d2)
  • theme: show version dropdown on versioned pages only (ab18f4d)
  • use versioned links in navbar (9a45f85)
  • theme: test for available headers before accessing (91bb50d)
  • adapt changed plugin name (e3f04de)
  • theme: use correct edit link for pages (953b39e)
  • versioning: include non-locale sidebar config in snapshot (#6) (4b817b4)
  • reset version number (d8a4be2)
  • versioning: more safeguards in case no versions were created yet (0615344)
  • add container plugin (346d31c)
  • add default theme color palette (31d20e6)
  • compare name instead of assign (e02d7a2)
  • versioning: page metadata and path fixes (5029baf)
  • versioning: properly generate versioned edit links (1be0e45)
  • versioning: properly handle static pages (2f1e49e)
  • prevent duplicate versions on full reload (33c83eb)
  • respect locale in version dropdown (3e80fe9)
  • update import paths for latest VuePress alpha (287445c)

Features

  • apidocs: add plugin options (d674e5f)
  • docgen: copy over images from any of the input paths for html output (7fd48b6)
  • docgen: make it work as an independent module (4ca640a)
  • docgen: reference free-form text content from other files (7eae53f)
  • theme: update code color (15f81f8)
  • validate: add ability to whitelist types (#5) (44d893b)
  • validate: more strict checks on event properties (ca8c76f)
  • versioning: add support for non-versioned pages (d6246cf)
  • versioning: search through current version only (ce69184)
  • custom next version label (85d0746)
  • make footer configurable (27e4e14)
  • update active header link in sidebar (31d4da7)
  • update to VuePress 1.0.2 (74d7ca8)

BREAKING CHANGES

  • validate: All documented event properties need to have a type

0.2.0 (2019-09-09)

Features

  • docgen: copy over images from any of the input paths for html output (7fd48b6)
  • validate: add ability to whitelist types (#5) (44d893b)

0.1.5 (2019-08-07)

Bug Fixes

  • docgen: correctly handle array syntax in callbacks (#3) (eb43ad5)

0.1.4 (2019-07-30)

Bug Fixes

  • docgen: add missing validate command (807f211)

0.1.3 (2019-07-27)

Bug Fixes

  • apidocs: replace state with correct structure during ssr (f2e3ed3)

0.1.2 (2019-07-27)

Bug Fixes

  • apidocs: properly render method and event params (28109e6)
  • apidocs: use type-links component instead of old custom formatter (8953f08)
  • theme: test for available headers before accessing (91bb50d)

0.1.1 (2019-07-27)

Bug Fixes

  • apidocs: use markdown renderer return type (7e935e5)

0.1.0 (2019-07-27)

Bug Fixes

  • apidocs: add platform availability icons (ece76c7)
  • apidocs: process metadata after markdown is completely initialized (3db479f)
  • docgen: add missing typescript generator changes (22d0779)
  • ios: do not show anchor links for top two level headings (c4b1497)
  • theme: add bottom padding to home page (6b2d0be)
  • theme: add default content class (d516092)
  • theme: apply latest theme-default (7b15292)
  • theme: guard against undefined paths (ed03520)
  • theme: height wrapper to avoid glitches (7923ded)
  • theme: mark versions dropdown as can-hide (eecb704)
  • theme: only show api sidebar button if page has api docs (06513cb)
  • prevent duplicate versions on full reload (33c83eb)
  • theme: show footer only if configured (9d9f4d2)
  • theme: show version dropdown on versioned pages only (ab18f4d)
  • theme: use correct edit link for pages (953b39e)
  • adapt changed plugin name (e3f04de)
  • versioning: more safeguards in case no versions were created yet (0615344)
  • add container plugin (346d31c)
  • add default theme color palette (31d20e6)
  • compare name instead of assign (e02d7a2)
  • reset version number (d8a4be2)
  • versioning: page metadata and path fixes (5029baf)
  • versioning: properly generate versioned edit links (1be0e45)
  • versioning: properly handle static pages (2f1e49e)
  • respect locale in version dropdown (3e80fe9)
  • update import paths for latest VuePress alpha (287445c)
  • use versioned links in navbar (9a45f85)

Features

  • custom next version label (85d0746)
  • make footer configurable (27e4e14)
  • update active header link in sidebar (31d4da7)
  • update to VuePress 1.0.2 (74d7ca8)
  • apidocs: add plugin options (d674e5f)
  • docgen: make it work as an independent module (4ca640a)
  • docgen: reference free-form text content from other files (7eae53f)
  • theme: update code color (15f81f8)
  • versioning: add support for non-versioned pages (d6246cf)
  • versioning: search through current version only (ce69184)