[alexander-yevsyukov]

Rewords the KDoc of configureApiDocs() in jvm-module.gradle.kts after a review-docs pass in base-libraries flagged it: the summary was wordy, and the second paragraph was a run-on with a negative aside tacked on at the end.

Before:

/**
 * Applies the plugin that registers the `publishApiDocs` task of this module.
 *
 * The `publish-api-docs.yml` workflow runs the task through `publishAllApiDocs` of
 * the root project, which depends on it for the published modules only. It is not
 * a part of `publish`.
 */

After:

/**
 * Registers the `publishApiDocs` task for this module.
 *
 * The `publish-api-docs.yml` workflow runs the task through the root project's
 * `publishAllApiDocs`, which depends on it only when this module is published.
 * The task is not part of `publish`.
 */

"Only when this module is published" replaces "for the published modules only" because the KDoc speaks of one module. The claims match PublishApiDocs.kt, PublishAllApiDocs.kt (which depends only on the published projects that have the task), and .github-workflows/publish-api-docs.yml (./gradlew :publishAllApiDocs).

Copies kept in sync

scripts/migrate-publish-api-docs.sh (from #817) adds this KDoc, word for word, to a consumer's configureGitHubPages() when it renames the function to configureApiDocs(). Its copy changes here too, as does the expected text in scripts/test-migrate-publish-api-docs.sh. Future migrations, such as Chords and Chords-Gradle-plugin, will get the new wording. Consumers that already migrated (base-libraries, testlib) keep their copy until someone edits it.

Checks

• scripts/test-migrate-publish-api-docs.sh: 43/43 PASS. That covers adding the KDoc only to a function that has none, and a second run that changes nothing. With the script's heredoc copy alone mutated, 3 checks fail, so the test catches drift between the copies.
• ./gradlew :buildSrc:test detekt: BUILD SUCCESSFUL. config's root project has no build task, and dokkaGenerate is not registered.
• shellcheck on both scripts: clean.
• pre-pr: PASS. review-docs, spine-code-review, and kotlin-engineer all returned APPROVE. The version gate does not apply, as config has no version.gradle.kts.

🤖 Generated with Claude Code

[chatgpt-codex-connector]

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review	Status	Commit	Review trigger
📝 Code Review	✅ Completed 2026-11-05T20:06:40.107800Z	8efd06a	Draft marked ready

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

• Open a pull request for review
• Mark a draft as ready
• Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

[Copilot]

🟢 Approved

No active review issues are reported for the documentation clarification.

No open issues 🎉

What changed in this PR

Clarifies the configureApiDocs() KDoc and keeps the migration-generated documentation and test expectations synchronized. No executable behavior changes.

Changes:

• Shortens the summary and clarifies the relationship between publishApiDocs, publishAllApiDocs, and publish.
• Applies identical wording to the migration template and its expected test output.

File	Description
scripts/​test-migrate-publish-api-docs.sh	Updates the expected KDoc text.
scripts/​migrate-publish-api-docs.sh	Updates the KDoc inserted during consumer migrations.
buildSrc/​src/​main/​kotlin/​jvm-module.gradle.kts	Rewords the source configureApiDocs() KDoc.

_{Review effort: Balanced}