Skip to content

Commit

Permalink
chore(deps): Update typedoc, typedoc theme and plugin (#15182)
Browse files Browse the repository at this point in the history
  • Loading branch information
dobromirts authored Jan 8, 2025
1 parent 4601f82 commit 65dd162
Show file tree
Hide file tree
Showing 11 changed files with 61 additions and 521 deletions.
550 changes: 45 additions & 505 deletions package-lock.json

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,7 @@
"gulp-uglify": "^3.0.1",
"hammer-simulator": "0.0.1",
"hammerjs": "^2.0.8",
"ig-typedoc-theme": "^5.0.4",
"ig-typedoc-theme": "^6.0.0",
"igniteui-dockmanager": "^1.15.2",
"igniteui-sassdoc-theme": "^1.2.3",
"igniteui-webcomponents": "5.1.2",
Expand Down Expand Up @@ -146,8 +146,8 @@
"stylelint-prettier": "^5.0.2",
"stylelint-scss": "^6.9.0",
"ts-node": "^10.8.1",
"typedoc": "^0.26.11",
"typedoc-plugin-localization": "^3.0.5",
"typedoc": "^0.27.0",
"typedoc-plugin-localization": "^3.0.6",
"typescript": "5.6.3"
}
}
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ let NEXT_ID = 0;
*
* @igxGroup Layouts
*
* @remark
* @remarks
* The Ignite UI for Angular Accordion component enables the user to navigate among multiple collapsing panels
* displayed in a single container.
* The accordion offers keyboard navigation and API to control the underlying panels' expansion state.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -650,7 +650,7 @@ export class IgxColumnComponent implements AfterContentInit, OnDestroy, ColumnTy
/**
* Applies display format to cell values in the column. Does not modify the underlying data.
*
* @remark
* @remarks
* Note: As the formatter is used in places like the Excel style filtering dialog, in certain
* scenarios (remote filtering for example), the row data argument can be `undefined`.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -4266,7 +4266,7 @@ export abstract class IgxGridBaseDirective implements GridType,
/**
* Gets/Sets the outlet used to attach the grid's overlays to.
*
* @remark
* @remarks
* If set, returns the outlet defined outside the grid. Otherwise returns the grid's internal outlet directive.
*/
@Input()
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,7 @@ export class IgxGridHeaderRowComponent implements DoCheck {
/**
* Header groups inside the header row.
*
* @remark
* @remarks
* Note: These are only the top level header groups in case there are multi-column headers
* or a specific column layout. If you want to get the flattened collection use the `groups`
* property below.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -69,7 +69,7 @@ export abstract class IgxHierarchicalGridBaseDirective extends IgxGridBaseDirect
/**
* Gets/Sets whether the expand/collapse all button in the header should be rendered.
*
* @remark
* @remarks
* The default value is false.
* @example
* ```html
Expand Down Expand Up @@ -111,7 +111,7 @@ export abstract class IgxHierarchicalGridBaseDirective extends IgxGridBaseDirect
/**
* Gets the outlet used to attach the grid's overlays to.
*
* @remark
* @remarks
* If set, returns the outlet defined outside the grid. Otherwise returns the grid's internal outlet directive.
*/
public override get outlet() {
Expand Down
2 changes: 1 addition & 1 deletion projects/igniteui-angular/src/lib/list/list.component.ts
Original file line number Diff line number Diff line change
Expand Up @@ -561,7 +561,7 @@ export class IgxListComponent extends IgxListBaseDirective {
/**
* Gets the `context` object of the template binding.
*
* @remark
* @remarks
* Gets the `context` object which represents the `template context` binding into the `list container`
* by providing the `$implicit` declaration which is the `IgxListComponent` itself.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -344,7 +344,7 @@ export class IgxTreeNodeComponent<T> extends ToggleAnimationPlayer implements Ig
/**
* Return the child nodes of the node (if any)
*
* @remark
* @remarks
* Returns `null` if node does not have children
*
* @example
Expand Down
2 changes: 1 addition & 1 deletion projects/igniteui-angular/src/lib/tree/tree.component.ts
Original file line number Diff line number Diff line change
Expand Up @@ -391,7 +391,7 @@ export class IgxTreeComponent implements IgxTree, OnInit, AfterViewInit, OnDestr
* Returns all of the nodes that match the passed searchTerm.
* Accepts a custom comparer function for evaluating the search term against the nodes.
*
* @remark
* @remarks
* Default search compares the passed `searchTerm` against the node's `data` Input.
* When using `findNodes` w/o a `comparer`, make sure all nodes have `data` passed.
*
Expand Down
8 changes: 4 additions & 4 deletions scripts/build-typedoc.mjs
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
import path from "path";
import { fileURLToPath } from "url";
import TypeDoc from "typedoc";
import { Application } from "typedoc";
import getArgs from "./get-args.mjs";

const product = "ignite-ui-angular";
Expand Down Expand Up @@ -52,9 +52,9 @@ const CONFIG = {
plugin: [
path.resolve(
__dirname,
"../node_modules/typedoc-plugin-localization/dist/",
"../node_modules/typedoc-plugin-localization/dist/index.js",
),
path.resolve(__dirname, "../node_modules/ig-typedoc-theme/dist/"),
path.resolve(__dirname, "../node_modules/ig-typedoc-theme/dist/index.js"),
],
theme: "igtheme",
excludePrivate: true,
Expand All @@ -66,7 +66,7 @@ const CONFIG = {
};

async function main() {
const app = await TypeDoc.Application.bootstrapWithPlugins(CONFIG);
const app = await Application.bootstrapWithPlugins(CONFIG);

app.options.setValue("localize", localize ?? "en");
app.options.setValue("product", product);
Expand Down

0 comments on commit 65dd162

Please sign in to comment.