diff options
| author | Koosha Khajeh Moogahi <koosha.khajeh@gmail.com> | 2012-06-17 14:15:57 +0200 |
|---|---|---|
| committer | Frédéric Buclin <LpSolit@gmail.com> | 2012-06-17 14:15:57 +0200 |
| commit | 35bf9943a87018e6cfa2d49f83f77c22205ddfc0 (patch) | |
| tree | 5b1f648f2a688506ed7c09f05c00c674f2929090 /Bugzilla/Component.pm | |
| parent | 776cbe8fc520f804e6f3556e104a8b081d0a2032 (diff) | |
| download | bugzilla-35bf9943a87018e6cfa2d49f83f77c22205ddfc0.tar.gz bugzilla-35bf9943a87018e6cfa2d49f83f77c22205ddfc0.tar.xz | |
Bug 765315: Mention the data type of 'product' param in POD of Bugzilla::Component->new to avoid misunderstanding
r/a=LpSolit
Diffstat (limited to 'Bugzilla/Component.pm')
| -rw-r--r-- | Bugzilla/Component.pm | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/Bugzilla/Component.pm b/Bugzilla/Component.pm index 5be6a4240..f18963946 100644 --- a/Bugzilla/Component.pm +++ b/Bugzilla/Component.pm @@ -487,10 +487,12 @@ Component.pm represents a Product Component object. Params: $param - If you pass an integer, the integer is the component ID from the database that we want to - read in. If you pass in a hash with the 'name' - and 'product' keys, then the value of the name - key is the name of a component being in the given - product. + read in. + However, If you pass in a hash, it must contain + two keys: + name (string): the name of the component + product (object): an object of Bugzilla::Product + representing the product that the component belongs to. Returns: A Bugzilla::Component object. |