Open
Bug 720879
Opened 13 years ago
Updated 2 years ago
Document the cycle collector macros
Categories
(Core :: Cycle Collector, task)
Core
Cycle Collector
Tracking
()
NEW
People
(Reporter: mccr8, Assigned: mccr8)
References
Details
Attachments
(1 file)
|
(deleted),
patch
|
Details | Diff | Splinter Review |
These are not really documented anywhere, and we're adding even more (bug 716518, bug 720423, bug 717500) so I should write up at least a little bit what is going on there, maybe in a comment in nsCycleCollectionParticipant.h.
|
Assignee | |
Comment 1•13 years ago
|
||
roc, what do you think about these explanations? I moved the description to near the macros, as that's probably where most people will look for an explanation.
Assignee: nobody → continuation
Attachment #596497 -
Flags: feedback?(roc)
|
||
Comment 2•13 years ago
|
||
Comment on attachment 596497 [details] [diff] [review]
document macros, avoid warnings for empty functions
>+// If _class is a SKIPPABLE class,
It would be useful to document how I can tell whether that's the case
|
|
Assignee | |
Comment 3•13 years ago
|
||
(In reply to Ms2ger from comment #2)
> It would be useful to document how I can tell whether that's the case
That's true, I can add a description at the top about what that means. I just mean that it is declared with one of the NS_DECL_CYCLE_COLLECTION_SKIPPABLE_* macros.
Where is it documented what the purple buffer is?
Are we expecting everyone who implements a CC-participant class to understand how cycle collection works?
|
||
Comment 5•13 years ago
|
||
I hope not. All the SKIP* are optional things, and we should make it clear.
That still needs to be documented. What if someone changes something so that a class that is currently SKIPPABLE no longer is?
|
|
Assignee | |
Comment 7•13 years ago
|
||
Good point, I'll have to think about how to explain this while avoiding cycle collector jargon.
|
|
Assignee | |
Updated•13 years ago
|
Attachment #596497 -
Flags: feedback?(roc)
|
||
Updated•5 years ago
|
Type: defect → task
|
||
Updated•2 years ago
|
Severity: normal → S3
|
|
Assignee | |
Updated•2 years ago
|
Component: XPCOM → Cycle Collector
You need to log in
before you can comment on or make changes to this bug.
Description
•