Closed Bug 2044291 Opened 5 months ago Closed 5 months ago

Source docs not building anymore (multiple documented objects)

Categories

(Thunderbird :: General, defect)

defect

Tracking

(Not tracked)

RESOLVED FIXED
153 Branch

People

(Reporter: babolivier, Assigned: babolivier)

References

(Regression)

Details

(Keywords: regression)

Attachments

(1 external file)

sphinx_js.suffix_tree.PathsTaken: Your code contains multiple documented objects at each of these paths:

  ./mail/components/accountcreation/content/widgets/account-hub-input.AccountHubInput#value

We won't know which one you're talking about.

JSDoc considers a getter and a setter as simply two methods with the same name,
which makes sphinx-js raise an error and fail the generation of our source docs.
As per https://github.com/jsdoc/jsdoc/issues/973 and others, their stance seems
to be that getters and setters should not be documented separately, and should
instead be documented together and as a property.

Target Milestone: --- → 153 Branch
Keywords: regression
Regressed by: 2014492

Pushed by sking@thunderbird.net:
https://hg.mozilla.org/comm-central/rev/28e93c5d6c20
Document getters and setters as properties in AccountHubInput. r=freaktechnik

Status: ASSIGNED → RESOLVED
Closed: 5 months ago
Resolution: --- → FIXED
Duplicate of this bug: 2039656
You need to log in before you can comment on or make changes to this bug.

Attachment

General

Created:
Updated:
Size: