]> git.ipfire.org Git - thirdparty/bugzilla.git/commitdiff
Bug 765315: Mention the data type of 'product' param in POD of Bugzilla::Component...
authorKoosha Khajeh Moogahi <koosha.khajeh@gmail.com>
Sun, 17 Jun 2012 12:15:57 +0000 (14:15 +0200)
committerFrédéric Buclin <LpSolit@gmail.com>
Sun, 17 Jun 2012 12:15:57 +0000 (14:15 +0200)
r/a=LpSolit

Bugzilla/Component.pm

index 5be6a4240ee603157ef2dd7d7a4f325e80ec2364..f189639468055dbe3cf8c108e92b79ff00847454 100644 (file)
@@ -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.