1915486 - Fix errors about 'Undefined substitution referenced' in migration code jsdocs

Status: RESOLVED FIXED

(Firefox :: Migration, task, P1)

Description

[Mark Banner (:standard8)]

I noticed there are some errors generated when docs are run for the migration code. They're all about the same:

MigrationUtils.sys.mjs:./browser/components/migration/MigrationUtils.sys.MigrationUtils(135):484: ERROR: Undefined substitution referenced: "migrate(aCallback)".
MigrationUtils.sys.mjs:./browser/components/migration/MigrationUtils.sys.MigrationUtils(135):484: ERROR: Undefined substitution referenced: "migrate".
MigrationUtils.sys.mjs:./browser/components/migration/MigrationUtils.sys.MigrationUtils(135):491: ERROR: Undefined substitution referenced: "migrate".
MigratorBase.sys.mjs:./browser/components/migration/MigratorBase.sys.MigratorBase(48):19: ERROR: Undefined substitution referenced: "startupOnlyMigrator".
MigratorBase.sys.mjs:./browser/components/migration/MigratorBase.sys.MigratorBase(48):304: ERROR: Undefined substitution referenced: "type".
MigratorBase.sys.mjs:./browser/components/migration/MigratorBase.sys.MigratorBase(48):308: ERROR: Undefined substitution referenced: "migrate".
MigratorBase.sys.mjs:./browser/components/migration/MigratorBase.sys.MigratorBase(48):308: ERROR: Undefined substitution referenced: "migrate".
MigratorBase.sys.mjs:./browser/components/migration/MigratorBase.sys.MigratorBase(48):327: ERROR: Undefined substitution referenced: "aCallback(true, {})".
EdgeProfileMigrator.sys.mjs:./browser/components/migration/EdgeProfileMigrator.sys.EdgeProfileMigrator(496):45: ERROR: Undefined substitution referenced: "null".

These are referencing cases where the JSDoc does something like: this is a description of something which might return |null|. The JSDoc processing is recognising the pipe symbols as some kind of substitution, rather than code. We should change it to use double-backticks and then the code gets generated correctly.

Comment 1

[Mark Banner (:standard8)]

Attachment: Bug 1915486 - Fix document generation errors about 'Undefined substitution referenced' in migration component's JSDoc. r?#migration-reviewers!

Comment 2

[Mark Banner (:standard8)]

Attachment: Bug 1915486 - Fix 'Document may not end with a transition' errors in Android documentation. r?#android-reviewers!

Comment 3

[Mark Banner (:standard8)]

Attachment: Bug 1915486 - Fix unknown target name issues in rst documents. r?sylvestre!

Comment 4

[Phabricator Automation]

Comment on attachment 9421507 [details]
Bug 1915486 - Fix 'Document may not end with a transition' errors in Android documentation. r?#android-reviewers!

Revision D220533 was moved to bug 1915550. Setting attachment 9421507 [details] to obsolete.

Comment 5

[Phabricator Automation]

Comment on attachment 9421508 [details]
Bug 1915486 - Fix unknown target name issues in rst documents. r?sylvestre!

Revision D220534 was moved to bug 1915550. Setting attachment 9421508 [details] to obsolete.

Comment 6

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/69f9690660a4
Fix document generation errors about 'Undefined substitution referenced' in migration component's JSDoc. r=migration-reviewers,mconley

Comment 7

[Norisz Fay [:noriszfay]]

https://hg.mozilla.org/mozilla-central/rev/69f9690660a4