Correct JSDoc for more object types

Author: mcmire

tests/functional/helpers/environment.ts

@@ -8,12 +8,12 @@ import Repo from './repo.js';
  * Describes the package that is used to initialize a polyrepo, or one of the
  * packages that is used to initialize a monorepo.
  *
- * name - The desired name of the package.
+ * Properties:
  *
- * version - The desired version of the package.
- *
- * directory - The path relative to the repo's root directory that
- * holds this package.
+ * - `name` - The desired name of the package.
+ * - `version` - The desired version of the package.
+ * - `directory` - The path relative to the repo's root directory that holds
+ *   this package.
  */
 export type PackageSpecification = {
   name: string;
@@ -24,13 +24,13 @@ export type PackageSpecification = {
 /**
  * A set of configuration options for an {@link Environment}.
  *
- * directoryPath - The directory out of which this environment will
- * operate.
+ * Properties:
  *
- * createInitialCommit - Usually when a repo is initialized, a commit
- * is created (which will contain starting `package.json` files). You can use
- * this option to disable that if you need to create your own commits for
- * clarity.
+ * - `directoryPath` - The directory out of which this environment will operate.
+ * - `createInitialCommit` - Usually when a repo is initialized, a commit is
+ *   created (which will contain starting `package.json` files). You can use
+ *   this option to disable that if you need to create your own commits for
+ *   clarity.
  */
 export type EnvironmentOptions = {
   directoryPath: string;

tests/functional/helpers/local-monorepo.ts

@@ -8,10 +8,10 @@ import { knownKeysOf } from './utils.js';
  * A set of configuration options for a {@link LocalMonorepo}. In addition
  * to the options listed in {@link LocalRepoOptions}, these include:
  *
- * packages - The known packages within this repo (including the
- * root).
+ * Properties
  *
- * workspaces - The known workspaces within this repo.
+ * - `packages` - The known packages within this repo (including the root).
+ * - `workspaces` - The known workspaces within this repo.
  */
 export type LocalMonorepoOptions<WorkspacePackageNickname extends string> = {
   packages: Record<WorkspacePackageNickname, PackageSpecification>;

tests/functional/helpers/monorepo-environment.ts

@@ -15,10 +15,15 @@ import { debug, knownKeysOf } from './utils.js';
  * A set of configuration options for a {@link MonorepoEnvironment}. In addition
  * to the options listed in {@link EnvironmentOptions}, these include:
  *
- * packages - The known packages within this repo (including the
- * root).
+ * Properties:
  *
- * workspaces - The known workspaces within this repo.
+ * - `packages` - The known packages within this repo (including the root).
+ * - `workspaces` - The known workspaces within this repo.
+ * - `directoryPath` - The directory out of which this environment will operate.
+ * - `createInitialCommit` - Usually when a repo is initialized, a commit is
+ *   created (which will contain starting `package.json` files). You can use
+ *   this option to disable that if you need to create your own commits for
+ *   clarity.
  */
 export type MonorepoEnvironmentOptions<
   WorkspacePackageNickname extends string,
@@ -30,8 +35,9 @@ export type MonorepoEnvironmentOptions<
 /**
  * The release specification data.
  *
- * packages - The workspace packages within this repo that will be
- * released.
+ * Properties:
+ *
+ * - `packages` - The workspace packages within this repo that will be released.
  */
 type ReleaseSpecification<WorkspacePackageNickname extends string> = {
   packages: Partial<Record<WorkspacePackageNickname, string>>;

tests/functional/helpers/repo.ts

@@ -9,8 +9,10 @@ import { isErrorWithCode } from '../../helpers.js';
 /**
  * A set of configuration options for a {@link Repo}.
  *
- * environmentDirectoryPath - The directory that holds the environment
- * that created this repo.
+ * Properties:
+ *
+ * - `environmentDirectoryPath` - The directory that holds the environment that
+ *   created this repo.
  */
 export type RepoOptions = {
   environmentDirectoryPath: string;