Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 355265 - IGateProvider 'enter' API description is too generic.
Summary: IGateProvider 'enter' API description is too generic.
Status: ASSIGNED
Alias: None
Product: RTSC
Classification: Technology
Component: Runtime (show other bugs)
Version: unspecified   Edit
Hardware: PC Windows XP
: P3 enhancement (vote)
Target Milestone: ---   Edit
Assignee: Alan DeMars CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2011-08-19 16:20 EDT by Alan DeMars CLA
Modified: 2011-11-29 14:30 EST (History)
2 users (show)

See Also:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Alan DeMars CLA 2011-08-19 16:20:41 EDT 
Build Identifier: 3.22

All Gate providers inherit the CDOC for enter and leave from IGateProvider. The inherited 'enter' CDOC is too esoteric. Needs to be simplified (like the 'leave' description). Perhaps the existing 'enter' description can be moved into the IGateProvider module description.

Reproducible: Always
Comment 1 Alan DeMars CLA 2011-08-19 16:25:16 EDT 
Quote from Mark Grosen:

"I was reviewing some code and was looking at “gates”. In ti.sysbios.gates, there are 6 different Gate variants. What I found lacking in the CDOC for these was the missing descriptions for the key methods: enter() and leave(). There is no function description for these nor is there a link to IGateProvider, leaving me wondering how to use these modules. Suggestions? (BTW, even when I get to IGateProvider, as a run-of-the-mill C programmer, I am left confused as to what exactly I should call.)"

A bug in the spec files for all ti.sysbios.gates accidentally nodoc'd enter/exit. However, per Mark's parenthetical remark in the last line above, even after fixing the nodoc problem, the generic 'enter' CDOC inherited from IGateProvider is still not sufficient for a user to know how/when to use the API.