Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add files showing typedoc bug #36

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
node_modules
docs
build
.DS_Store
package-lock.json
2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "typedoc-repros",
"dependencies": {
"typedoc": "latest",
"typedoc": "^0.25.4",
"typescript": "latest"
}
}
14 changes: 14 additions & 0 deletions src/BugAbstractSubject.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
/** The base class. Has method {@link getAbstractSubject} */
export class BugAbstractSubject {

/**
*/
constructor() {
};

/** returns the string 'AbstractSubject' */
getAbstractSubject(): string {
return 'AbstractSubject';
};

} // end BugAbstractSubject class
16 changes: 16 additions & 0 deletions src/BugContactSim.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
import { BugImpulseSim } from './BugImpulseSim.js';

/** The fourth class in hierarchy.
Inherits the method {@link getImpulseSim} aka {@link BugImpulseSim.getImpulseSim}.

Inherits method {@link getRigidBodySim} aka {@link BugRigidBodySim.BugRigidBodySim.getRigidBodySim}
*/
export class BugContactSim extends BugImpulseSim {

/**
*/
constructor() {
super();
};

} // end class
26 changes: 26 additions & 0 deletions src/BugImpulseSim.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
import { BugRigidBodySim } from './BugRigidBodySim.js';

/** The third class in hierarchy.

Adds method {@link getImpulseSim} aka {@link BugImpulseSim.getImpulseSim}.

Inherits method {@link getRigidBodySim} aka {@link BugRigidBodySim.getRigidBodySim}

Inherits method {@link getAbstractSubject}

this causes error with typedoc: \@link BugContactSim.getImpulseSim
*/
export class BugImpulseSim extends BugRigidBodySim {
/**
*/
constructor() {
super();
};

/** returns the string 'ImpulseSim' */
getImpulseSim(): string {
return 'ImpulseSim';
};

} // end class

22 changes: 22 additions & 0 deletions src/BugRigidBodySim.ts
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
import { BugAbstractSubject } from './BugAbstractSubject.js';

/** The second class in hierarchy.

Adds method {@link getRigidBodySim} aka {@link BugRigidBodySim.getRigidBodySim}

Inherits method {@link getAbstractSubject}
*/
export class BugRigidBodySim extends BugAbstractSubject {

/**
*/
constructor() {
super();
};

/** returns the string 'RigidBodySim' */
getRigidBodySim(): string {
return 'RigidBodySim';
};

} // end BugRigidBodySim class
5 changes: 3 additions & 2 deletions tsconfig.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"compilerOptions": {
"strict": true
"strict": true,
"outDir": "build",
},
"include": ["src"]
"include": ["src/**/*"]
}
3 changes: 2 additions & 1 deletion typedoc.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,7 @@
{
"$schema": "https://typedoc.org/schema.json",
"entryPoints": ["src/index.ts"],
"entryPointStrategy": "expand",
"entryPoints": ["./src"],

"treatWarningsAsErrors": true,
"out": "docs",
Expand Down
Loading