Skip to content

Commit

Permalink
Update typedoc.json files with package names
Browse files Browse the repository at this point in the history
  • Loading branch information
b3hr4d committed Feb 16, 2024
1 parent e647ba9 commit 50bd9b9
Show file tree
Hide file tree
Showing 9 changed files with 40 additions and 2 deletions.
2 changes: 1 addition & 1 deletion packages/store/typedoc.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"$schema": "https://typedoc.org/schema.json",
"entryPoints": ["./src"],
"entryPointStrategy": "resolve"
"name": "Store"
}
6 changes: 6 additions & 0 deletions packages/visitor/src/details/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,12 @@ import { FieldType } from "../types"

export * from "./types"

/**
* Visit the candid file and extract the details.
* It returns the extracted service details.
*
* @category Main
*/
export class VisitDetails<
A extends ActorSubclass<any> = DefaultActorType
> extends IDL.Visitor<
Expand Down
6 changes: 6 additions & 0 deletions packages/visitor/src/fields/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,12 @@ import type {
export * from "./types"
export * from "../helper"

/**
* Visit the candid file and extract the fields.
* It returns the extracted service fields.
*
* @category Main
*/
export class VisitFields<
A extends ActorSubclass<any> = DefaultActorType,
M extends FunctionName<A> = FunctionName<A>
Expand Down
6 changes: 6 additions & 0 deletions packages/visitor/src/random/args.ts
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,12 @@ import {
FunctionName,
} from "@ic-reactor/store"

/**
* Visit the candid file and extract the fields.
* It returns the extracted service fields.
*
* @category Main
*/
export class VisitRandomArgs<
A extends ActorSubclass<any> = DefaultActorType
> extends IDL.Visitor<any, any> {
Expand Down
6 changes: 6 additions & 0 deletions packages/visitor/src/random/response.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@ import {
FunctionName,
} from "@ic-reactor/store"

/**
* Visit the candid file and extract the fields.
* It returns the extracted service fields.
*
* @category Main
*/
export class VisitRandomResponse<
A extends ActorSubclass<any> = DefaultActorType,
M extends FunctionName<A> = FunctionName<A>
Expand Down
6 changes: 6 additions & 0 deletions packages/visitor/src/transform/normal/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,12 @@ import type {

export * from "./types"

/**
* Visit the candid file and extract the fields.
* It returns the extracted service fields.
*
* @category Main
*/
export class VisitTransform<
A extends ActorSubclass<any> = DefaultActorType,
M extends FunctionName<A> = FunctionName<A>
Expand Down
6 changes: 6 additions & 0 deletions packages/visitor/src/transform/table/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,12 @@ import type {
Principal,
} from "@ic-reactor/store"

/**
* Visit the candid file and extract the fields.
* It returns the extracted service fields.
*
* @category Main
*/
export class VisitTransformTable<
A extends ActorSubclass<any> = DefaultActorType,
M extends FunctionName<A> = FunctionName<A>
Expand Down
3 changes: 2 additions & 1 deletion packages/visitor/typedoc.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,5 @@
{
"$schema": "https://typedoc.org/schema.json",
"entryPoints": ["./src"]
"entryPoints": ["./src"],
"name": "Visitor"
}
1 change: 1 addition & 0 deletions typedoc.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
"name": "ic-reactor",
"customTitle": "ic-reactor",
"navigationLinks": {
"Examples": "https://github.com/B3Pay/ic-reactor/tree/main/examples",
"NPM": "https://www.npmjs.com/org/ic-reactor",
"GitHub": "https://github.com/B3Pay/ic-reactor"
},
Expand Down

0 comments on commit 50bd9b9

Please sign in to comment.