Some javadoc added
[phpeclipse.git] / net.sourceforge.phpeclipse / src / net / sourceforge / phpeclipse / phpeditor / phpparser / PHPFunctionDeclaration.java
1 package net.sourceforge.phpeclipse.phpeditor.phpparser;
2
3 import net.sourceforge.phpdt.internal.ui.PHPUiImages;
4 import org.eclipse.jface.resource.ImageDescriptor;
5
6 /**
7  * A function declaration.
8  * @author khartlage
9  */
10 public class PHPFunctionDeclaration extends PHPSegmentWithChildren {
11
12   /**
13    * Create a function declaration.
14    * @param parent the parent object (it should be a php class)
15    * @param name the name of the function
16    * @param index where the function is in the file
17    */
18   public PHPFunctionDeclaration(Object parent, String name, int index) {
19     super(parent, name, index);
20   }
21   
22   /**
23    * Get the image of a class.
24    * @return the image that represents a php class
25    */
26   public ImageDescriptor getImage() {
27     return PHPUiImages.DESC_FUN;
28   }
29 }