Add script to generate docs

Change-Id: I639b7123c6b3b9d32ee7544f8d015c0c0b27de43
Reviewed-on: http://review.couchbase.org/c/php-couchbase/+/141555
Tested-by: Build Bot <[email protected]>
Reviewed-by: Sergey Avseyev <[email protected]>

Author: avsej

.gitignore

@@ -45,3 +45,4 @@
 /test.cache
 /tests/CouchbaseMock.jar
 /phpunit.result.cache
+.phpdoc

api/couchbase.php

@@ -2389,7 +2389,7 @@ public function consistentWith(string $index, MutationState $state): SearchOptio
          * If empty, no field values are included. This drives the inclusion of the fields in each hit.
          * Note that to be highlighted, the fields must be stored in the FTS index.
          *
-         * @param string ...$fields
+         * @param string[] $fields
          * @return SearchOptions
          */
         public function fields(array $fields): SearchOptions
@@ -2404,7 +2404,7 @@ public function fields(array $fields): SearchOptions
          *
          * Note that to be faceted, a field's value must be stored in the FTS index.
          *
-         * @param array[SearchFacet] $facet
+         * @param SearchFacet[] $facets
          * @return SearchOptions
          *
          * @see \SearchFacet

bin/docs.sh

@@ -0,0 +1,38 @@
+#!/usr/bin/env bash
+
+#    Copyright 2020 Couchbase, Inc.
+#
+#  Licensed under the Apache License, Version 2.0 (the "License");
+#  you may not use this file except in compliance with the License.
+#  You may obtain a copy of the License at
+#
+#      http://www.apache.org/licenses/LICENSE-2.0
+#
+#  Unless required by applicable law or agreed to in writing, software
+#  distributed under the License is distributed on an "AS IS" BASIS,
+#  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+#  See the License for the specific language governing permissions and
+#  limitations under the License.
+
+PROJECT_ROOT="$( cd "$(dirname "$0"/..)" >/dev/null 2>&1 ; pwd -P )"
+
+set -x
+set -e
+
+CB_VERSION=${CB_VERSION:-$(git describe | sed 's/^v//g')}
+CB_PHP_PREFIX=${CB_PHP_PREFIX:-/usr}
+
+CB_PHPDOC_PHAR=${CB_PHPDOC_PHAR:-"${PROJECT_ROOT}/build/phpdoc.phar"}
+if [ ! -f "${CB_PHPDOC_PHAR}" ]
+then
+    curl -L -o "${CB_PHPDOC_PHAR}" https://github.com/phpDocumentor/phpDocumentor/releases/download/v3.0.0/phpDocumentor.phar
+fi
+
+cd ${PROJECT_ROOT}
+
+PHP_EXECUTABLE="${CB_PHP_PREFIX}/bin/php"
+
+${PHP_EXECUTABLE} \
+    ${CB_PHPDOC_PHAR} \
+    -t ${PROJECT_ROOT}/build/couchbase-php-client-${CB_VERSION} \
+    -d ${PROJECT_ROOT}/api

bin/test.sh

@@ -30,7 +30,7 @@ CB_PASSWORD=${CB_PASSWORD:-password}
 CB_PHPUNIT_PHAR=${CB_PHPUNIT_PHAR:-"${PROJECT_ROOT}/build/phpunit.phar"}
 if [ ! -f "${CB_PHPUNIT_PHAR}" ]
 then
-    curl -o "${CB_PHPUNIT_PHAR}" https://phar.phpunit.de/phpunit-9.4.3.phar
+    curl -L -o "${CB_PHPUNIT_PHAR}" https://phar.phpunit.de/phpunit-9.4.3.phar
 fi
 
 ${CB_PHP_PREFIX}/bin/php --version