JSDoc based doc generation broken by account hub
Categories
(Thunderbird :: Account Manager, defect)
Tracking
(thunderbird135 fixed)
Tracking | Status | |
---|---|---|
thunderbird135 | --- | fixed |
People
(Reporter: freaktechnik, Assigned: freaktechnik)
References
(Regression)
Details
(Keywords: regression)
Attachments
(2 files)
To quote from bug 1932006:
(In reply to Martin Giger [:freaktechnik] from comment #7)
(In reply to Heather Ellsworth from comment #6)The two patches that fixed this issue broke the ability to build the thunderbird source docs with
mach tb-doc
with the error:Extension error (sphinx_js): Handler <function analyze at 0x7fd1dd52ac00> for event 'builder-inited' threw an exception (exception: Your code contains multiple documented objects at each of these paths: ./mail/components/accountcreation/views/email.AccountHubEmail#abortable ./mail/components/accountcreation/views/email.AccountHubEmail#abortable We won't know which one you're talking about.)
Can you please fix the same named abortable objects?
There are two issues in the code it appears, first off there's documentation on both the getter and the setter of
AccountHubEmail.abortable
. In addition that documentation is written for methods. However, a getter/setter pair should be documented like a single property.Secondly JSDoc sadly gets really confused with private fields for our docs, and it appears to treat
#abortable
as having the same name and visibility asabortable
. So something like the following [removed for brevity] makes it work - but I'm not sure how valid that name of the private abortable field is. We should probably also have a comment to note that this is a workaround for the jsdoc generation.
Assignee | ||
Updated•2 months ago
|
Assignee | ||
Comment 1•2 months ago
|
||
Assignee | ||
Comment 2•2 months ago
|
||
The jsdoc gen can probably safely ignore test files.
Assignee | ||
Updated•2 months ago
|
Pushed by mkmelin@iki.fi:
https://hg.mozilla.org/comm-central/rev/864259b6f1e1
Fix jsdoc generation for account hub. r=vineet
https://hg.mozilla.org/comm-central/rev/21c538871138
Fix config used for source doc command. r=heather,rjl
Description
•