net.sourceforge.phpeclipse/src/net/sourceforge/phpdt/internal/corext/phpdoc/PHPDocUtil.java

   1 /*
   2  * Created on 20.09.2003
   3  *
   4  * To change the template for this generated file go to
   5  * Window&gt;Preferences&gt;Java&gt;Code Generation&gt;Code and Comments
   6  */
   7 package net.sourceforge.phpdt.internal.corext.phpdoc;
   8
   9 import java.io.FileReader;
  10 import java.io.IOException;
  11
  12 import net.sourceforge.phpeclipse.builder.PHPIdentifierLocation;
  13
  14 /**
  15  * @author khartlage
  16  *
  17  * To change the template for this generated type comment go to
  18  * Window&gt;Preferences&gt;Java&gt;Code Generation&gt;Code and Comments
  19  */
  20 public class PHPDocUtil {
  21
  22         /**
  23          * Generate a PHPDoc hover text if possible
  24          *
  25          * @param hoverInfoBuffer
  26          * @param filename
  27          * @param location
  28          */
  29   public static void appendPHPDoc(StringBuffer hoverInfoBuffer, String filename, PHPIdentifierLocation location) {
  30     hoverInfoBuffer.append(location.toString());
  31     hoverInfoBuffer.append('\n');
  32     if (location.getPHPDocOffset() >= 0) {
  33       FileReader phpdocFileReader;
  34       try {
  35         phpdocFileReader = new FileReader(filename);
  36
  37         char[] charArray = new char[location.getPHPDocLength()];
  38         phpdocFileReader.skip(location.getPHPDocOffset());
  39         phpdocFileReader.read(charArray, 0, location.getPHPDocLength());
  40         PHPDocCharArrayCommentReader phpdocConverter = new PHPDocCharArrayCommentReader(charArray);
  41         hoverInfoBuffer.append(phpdocConverter.getString());
  42         hoverInfoBuffer.append('\n');
  43       } catch (IOException e) {
  44       }
  45     }
  46   }
  47 }