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.

Sign up for GitHub

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

docs: Issue 76 Replacing undocumented comments with actual comments using JSDoc #82

Closed
wants to merge 2 commits into from
Closed

docs: Issue 76 Replacing undocumented comments with actual comments using JSDoc #82

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
1cf7467
Replacing undocumented comments with actual comments using JSDoc
abhishek-gite-cko Jun 21, 2023
bde3b54
fix: Replacing undocumented comments with actual comments using JSDoc
abhishek-gite-cko Jun 21, 2023
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
24 changes: 12 additions & 12 deletions etc/fiddle-core.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,29 +15,29 @@ import { Writable } from 'stream';
// @public
export class BaseVersions implements Versions {
constructor(versions: unknown);
// (undocumented)
/** @returns {@link ReleaseInfo} `version` is a release that this object knows about */
getReleaseInfo(ver: SemOrStr): ReleaseInfo | undefined;
// (undocumented)
/** @returns all versions matching that major number.*/
inMajor(major: number): SemVer[];
// (undocumented)
/** @returns all versions in a range, inclusive. */
inRange(a: SemOrStr, b: SemOrStr): SemVer[];
// (undocumented)
/** @returns true iff `version` is a release that this object knows about */
isVersion(ver: SemOrStr): boolean;
// (undocumented)
/** @returns latest version */
get latest(): SemVer | undefined;
// (undocumented)
/** @returns latest stable version */
get latestStable(): SemVer | undefined;
// (undocumented)
/** @returns obsolete major versions */
get obsoleteMajors(): number[];
// (undocumented)
/** @returns branches that only have prereleases */
get prereleaseMajors(): number[];
// (undocumented)

protected setVersions(val: unknown): void;
// (undocumented)
/** @returns stable major versions */
get stableMajors(): number[];
// (undocumented)
/** @returns branches that have supported stable releases */
get supportedMajors(): number[];
// (undocumented)
/** @returns returns all versions */
get versions(): SemVer[];
}

Expand Down