more doc fixes

jcupitt · jcupitt · commit e83bd5665391 · 2017-07-08T12:05:26.000+01:00
phpdoc doesn't seem to recognise types on array returns
diff --git a/examples/generate_phpdoc.rb b/examples/generate_phpdoc.rb
@@ -56,13 +56,13 @@ def enum?(name)
     return false
 end
 
-# map Ruby type names to PHP type names
+# map Ruby type names to PHP argument type names
 $to_php_map = {
     "Vips::Image" => "Image",
     "Image" => "Image",
     "Array<Integer>" => "integer[]|integer",
     "Array<Double>" => "float[]|float",
-    "Array<Image>" => "Image[]",
+    "Array<Image>" => "Image[]|image",
     "Integer" => "integer",
     "gint" => "integer",
     "guint64" => "integer",
@@ -77,8 +77,29 @@ def enum?(name)
     "gpointer" => "string",
 }
 
-def type_to_php(type)
-    return $to_php_map[type] if $to_php_map.include?(type) 
+# php result type names are different, annoyingly, and very restricted
+$to_php_result_map = {
+    "Vips::Image" => "Image",
+    "Image" => "Image",
+    "Array<Integer>" => "array",
+    "Array<Double>" => "array",
+    "Array<Image>" => "array",
+    "Integer" => "integer",
+    "gint" => "integer",
+    "guint64" => "integer",
+    "Double" => "float",
+    "gdouble" => "float",
+    "Float" => "float",
+    "String" => "string",
+    "Boolean" => "bool",
+    "gboolean" => "bool",
+    "Vips::Blob" => "string",
+    "gchararray" => "string",
+    "gpointer" => "string",
+}
+
+def type_to_php(map, type)
+    return map[type] if map.include?(type) 
     return "string" if enum? type
 
     # no mapping found
@@ -88,7 +109,11 @@ def type_to_php(type)
 
 class Vips::Argument
     def to_php
-        type_to_php type
+        type_to_php $to_php_map, type
+    end
+
+    def to_php_result
+        type_to_php $to_php_result_map, type
     end
 end
 
@@ -151,7 +176,7 @@ def generate_operation(file, op)
     if required_output.length == 0
         file << "void "
     elsif required_output.length == 1
-        file << "#{required_output[0].to_php} "
+        file << "#{required_output[0].to_php_result} "
     else 
         # we generate a Returns: block for this case, see below
         file << "array "
@@ -272,7 +297,7 @@ def generate_class(file, gtype)
     Vips::Image.properties.each do |name|
         php_name = name.tr "-", "_"
         p = Vips::Image.property name
-        file << " * @property #{type_to_php p.value_type.name} "
+        file << " * @property #{type_to_php $to_php_map, p.value_type.name} "
         file << "$#{php_name} #{p.blurb}\n"
         if enum? p.value_type.name
             php_name = p.value_type.name.tap{|s| s.slice!("Vips")}
diff --git a/src/ImageAutodoc.php b/src/ImageAutodoc.php
@@ -57,7 +57,7 @@
  * @method Image complex2(Image $right, string $cmplx, array $options = []) Complex binary operations on two images.
  *     @see OperationComplex2 for possible values for $cmplx
  * @method Image complexform(Image $right, array $options = []) Form a complex image from two real images.
- * @method static Image sum(Image[] $in, array $options = []) Sum an array of images.
+ * @method static Image sum(Image[]|image $in, array $options = []) Sum an array of images.
  * @method Image invert(array $options = []) Invert an image.
  * @method Image linear(float[]|float $a, float[]|float $b, array $options = []) Calculate (a * in + b).
  * @method Image math(string $math, array $options = []) Apply a math operation to an image.
@@ -98,7 +98,7 @@
  *         'rows' => @type Image First non-zero pixel in row.
  *     ];
  * @method Image measure(integer $h, integer $v, array $options = []) Measure a set of patches on a colour chart.
- * @method float[]|float getpoint(integer $x, integer $y, array $options = []) Read a point from an image.
+ * @method array getpoint(integer $x, integer $y, array $options = []) Read a point from an image.
  * @method Image copy(array $options = []) Copy an image.
  * @method Image tilecache(array $options = []) Cache an image as a set of tiles.
  * @method Image linecache(array $options = []) Cache an image as a set of lines.
@@ -110,7 +110,7 @@
  * @method Image insert(Image $sub, integer $x, integer $y, array $options = []) Insert image @sub into @main at @x, @y.
  * @method Image join(Image $in2, string $direction, array $options = []) Join a pair of images.
  *     @see Direction for possible values for $direction
- * @method static Image arrayjoin(Image[] $in, array $options = []) Join an array of images.
+ * @method static Image arrayjoin(Image[]|image $in, array $options = []) Join an array of images.
  * @method Image smartcrop(integer $width, integer $height, array $options = []) Extract an area from an image.
  * @method Image extract_band(integer $band, array $options = []) Extract band from an image.
  * @method Image bandjoin_const(float[]|float $c, array $options = []) Append a constant band to an image.
