Merge pull request #22432 from nextcloud/enh/phpdoc

Add php docs build script
nextcloud · Aug 26, 2020 · b5e9f7e · b5e9f7e
2 parents 7685d1f + 45a4740
commit b5e9f7e
Show file tree

Hide file tree

Showing 229 changed files with 11 additions and 229 deletions.
diff --git a/build/phpDocumentor.sh b/build/phpDocumentor.sh
@@ -0,0 +1,11 @@
+#!/bin/bash
+
+# Use a cached version of phpDocumentor for now since there is no release yet
+# and the github actions artifacts might disappear
+# This phar is downloaded from https://github.com/phpDocumentor/phpDocumentor/actions/runs/221599704
+
+wget https://bitgrid.net/~jus/phpDocumentor.phar
+
+mkdir -p api/
+
+php7.4 phpDocumentor.phar -t "./api" -d "./lib/public" --title="Nextcloud PHP API (`git rev-parse --abbrev-ref HEAD`)"
diff --git a/lib/public/Accounts/IAccount.php b/lib/public/Accounts/IAccount.php
@@ -32,7 +32,6 @@
  * Interface IAccount
  *
  * @since 15.0.0
- * @package OCP\Accounts
  */
 interface IAccount extends \JsonSerializable {
 

diff --git a/lib/public/Accounts/IAccountManager.php b/lib/public/Accounts/IAccountManager.php
@@ -34,7 +34,6 @@
  *
  * @since 15.0.0
  *
- * @package OCP\Accounts
  */
 interface IAccountManager {
 

diff --git a/lib/public/Accounts/IAccountProperty.php b/lib/public/Accounts/IAccountProperty.php
@@ -29,7 +29,6 @@
 /**
  * Interface IAccountProperty
  *
- * @package OCP\Account
  * @since 15.0.0
  */
 interface IAccountProperty extends \JsonSerializable {

diff --git a/lib/public/Accounts/PropertyDoesNotExistException.php b/lib/public/Accounts/PropertyDoesNotExistException.php
@@ -29,7 +29,6 @@
  *
  * @since 15.0.0
  *
- * @package OCP\Accounts
  */
 class PropertyDoesNotExistException extends \Exception {
 

diff --git a/lib/public/Activity/IConsumer.php b/lib/public/Activity/IConsumer.php
@@ -36,7 +36,6 @@
 /**
  * Interface IConsumer
  *
- * @package OCP\Activity
  * @since 6.0.0
  */
 interface IConsumer {

diff --git a/lib/public/Activity/IEvent.php b/lib/public/Activity/IEvent.php
@@ -39,7 +39,6 @@
 /**
  * Interface IEvent
  *
- * @package OCP\Activity
  * @since 8.2.0
  */
 interface IEvent {

diff --git a/lib/public/Activity/IEventMerger.php b/lib/public/Activity/IEventMerger.php
@@ -26,7 +26,6 @@
 /**
  * Interface EventMerger
  *
- * @package OCP\Activity
  * @since 11.0
  */
 interface IEventMerger {

diff --git a/lib/public/Activity/IExtension.php b/lib/public/Activity/IExtension.php
@@ -29,7 +29,6 @@
 /**
  * Interface IExtension
  *
- * @package OCP\Activity
  * @since 8.0.0
  */
 interface IExtension {

diff --git a/lib/public/Activity/IFilter.php b/lib/public/Activity/IFilter.php
@@ -26,7 +26,6 @@
 /**
  * Interface IFilter
  *
- * @package OCP\Activity
  * @since 11.0.0
  */
 interface IFilter {

diff --git a/lib/public/Activity/IManager.php b/lib/public/Activity/IManager.php
@@ -32,7 +32,6 @@
 /**
  * Interface IManager
  *
- * @package OCP\Activity
  * @since 6.0.0
  */
 interface IManager {

diff --git a/lib/public/Activity/IProvider.php b/lib/public/Activity/IProvider.php
@@ -26,7 +26,6 @@
 /**
  * Interface IProvider
  *
- * @package OCP\Activity
  * @since 11.0.0
  */
 interface IProvider {

diff --git a/lib/public/Activity/ISetting.php b/lib/public/Activity/ISetting.php
@@ -26,7 +26,6 @@
 /**
  * Interface ISetting
  *
- * @package OCP\Activity
  * @since 11.0.0
  */
 interface ISetting {

diff --git a/lib/public/App/AppPathNotFoundException.php b/lib/public/App/AppPathNotFoundException.php
@@ -27,7 +27,6 @@
 /**
  * Class AppPathNotFoundException
  *
- * @package OCP\App
  * @since 11.0.0
  */
 class AppPathNotFoundException extends \Exception {

diff --git a/lib/public/App/IAppManager.php b/lib/public/App/IAppManager.php
@@ -37,7 +37,6 @@
 /**
  * Interface IAppManager
  *
- * @package OCP\App
  * @since 8.0.0
  */
 interface IAppManager {

diff --git a/lib/public/App/ManagerEvent.php b/lib/public/App/ManagerEvent.php
@@ -29,7 +29,6 @@
 /**
  * Class ManagerEvent
  *
- * @package OCP\APP
  * @since 9.0.0
  */
 class ManagerEvent extends Event {

diff --git a/lib/public/AppFramework/App.php b/lib/public/AppFramework/App.php
@@ -46,7 +46,6 @@
 
 /**
  * Class App
- * @package OCP\AppFramework
  *
  * Any application must inherit this call - all controller instances to be used are
  * to be registered using IContainer::registerService

diff --git a/lib/public/AppFramework/Http/ContentSecurityPolicy.php b/lib/public/AppFramework/Http/ContentSecurityPolicy.php
@@ -38,7 +38,6 @@
  *
  * This class allows unsafe-eval of javascript and unsafe-inline of CSS.
  *
- * @package OCP\AppFramework\Http
  * @since 8.1.0
  */
 class ContentSecurityPolicy extends EmptyContentSecurityPolicy {

diff --git a/lib/public/AppFramework/Http/DataDisplayResponse.php b/lib/public/AppFramework/Http/DataDisplayResponse.php
@@ -30,7 +30,6 @@
 /**
  * Class DataDisplayResponse
  *
- * @package OCP\AppFramework\Http
  * @since 8.1.0
  */
 class DataDisplayResponse extends Response {

diff --git a/lib/public/AppFramework/Http/DataDownloadResponse.php b/lib/public/AppFramework/Http/DataDownloadResponse.php
@@ -27,7 +27,6 @@
 /**
  * Class DataDownloadResponse
  *
- * @package OCP\AppFramework\Http
  * @since 8.0.0
  */
 class DataDownloadResponse extends DownloadResponse {

diff --git a/lib/public/AppFramework/Http/EmptyContentSecurityPolicy.php b/lib/public/AppFramework/Http/EmptyContentSecurityPolicy.php
@@ -35,7 +35,6 @@
  * As alternative with sane exemptions look at ContentSecurityPolicy
  *
  * @see \OCP\AppFramework\Http\ContentSecurityPolicy
- * @package OCP\AppFramework\Http
  * @since 9.0.0
  */
 class EmptyContentSecurityPolicy {

diff --git a/lib/public/AppFramework/Http/EmptyFeaturePolicy.php b/lib/public/AppFramework/Http/EmptyFeaturePolicy.php
@@ -34,7 +34,6 @@
  * As alternative with sane exemptions look at FeaturePolicy
  *
  * @see \OCP\AppFramework\Http\FeaturePolicy
- * @package OCP\AppFramework\Http
  * @since 17.0.0
  */
 class EmptyFeaturePolicy {

diff --git a/lib/public/AppFramework/Http/FeaturePolicy.php b/lib/public/AppFramework/Http/FeaturePolicy.php
@@ -35,7 +35,6 @@
  * notice that Nextcloud ships already with sensible defaults and those policies
  * should require no modification at all for most use-cases.
  *
- * @package OCP\AppFramework\Http
  * @since 17.0.0
  */
 class FeaturePolicy extends EmptyFeaturePolicy {

diff --git a/lib/public/AppFramework/Http/FileDisplayResponse.php b/lib/public/AppFramework/Http/FileDisplayResponse.php
@@ -28,7 +28,6 @@
 /**
  * Class FileDisplayResponse
  *
- * @package OCP\AppFramework\Http
  * @since 11.0.0
  */
 class FileDisplayResponse extends Response implements ICallbackResponse {

diff --git a/lib/public/AppFramework/Http/ICallbackResponse.php b/lib/public/AppFramework/Http/ICallbackResponse.php
@@ -28,7 +28,6 @@
 /**
  * Interface ICallbackResponse
  *
- * @package OCP\AppFramework\Http
  * @since 8.1.0
  */
 interface ICallbackResponse {

diff --git a/lib/public/AppFramework/Http/StreamResponse.php b/lib/public/AppFramework/Http/StreamResponse.php
@@ -32,7 +32,6 @@
 /**
  * Class StreamResponse
  *
- * @package OCP\AppFramework\Http
  * @since 8.1.0
  */
 class StreamResponse extends Response implements ICallbackResponse {

diff --git a/lib/public/AppFramework/Http/StrictContentSecurityPolicy.php b/lib/public/AppFramework/Http/StrictContentSecurityPolicy.php
@@ -39,7 +39,6 @@
  * This class represents out strictest defaults. They may get change from release
  * to release if more strict CSP directives become available.
  *
- * @package OCP\AppFramework\Http
  * @since 14.0.0
  * @deprecated 17.0.0
  */

diff --git a/lib/public/AppFramework/Http/StrictEvalContentSecurityPolicy.php b/lib/public/AppFramework/Http/StrictEvalContentSecurityPolicy.php
@@ -39,7 +39,6 @@
  * This is a temp helper class from the default ContentSecurityPolicy to allow slow
  * migration to a stricter CSP. This does not allow unsafe eval.
  *
- * @package OCP\AppFramework\Http
  * @since 14.0.0
  * @deprecated 17.0.0
  */

diff --git a/lib/public/AppFramework/Http/StrictInlineContentSecurityPolicy.php b/lib/public/AppFramework/Http/StrictInlineContentSecurityPolicy.php
@@ -39,7 +39,6 @@
  * This is a temp helper class from the default ContentSecurityPolicy to allow slow
  * migration to a stricter CSP. This does not allow inline styles.
  *
- * @package OCP\AppFramework\Http
  * @since 14.0.0
  * @deprecated 17.0.0
  */

diff --git a/lib/public/AppFramework/Http/Template/ExternalShareMenuAction.php b/lib/public/AppFramework/Http/Template/ExternalShareMenuAction.php
@@ -31,7 +31,6 @@
 /**
  * Class LinkMenuAction
  *
- * @package OCP\AppFramework\Http\Template
  * @since 14.0.0
  */
 class ExternalShareMenuAction extends SimpleMenuAction {

diff --git a/lib/public/AppFramework/Http/Template/IMenuAction.php b/lib/public/AppFramework/Http/Template/IMenuAction.php
@@ -27,7 +27,6 @@
 /**
  * Interface IMenuAction
  *
- * @package OCP\AppFramework\Http\Template
  * @since 14.0
  */
 interface IMenuAction {

diff --git a/lib/public/AppFramework/Http/Template/LinkMenuAction.php b/lib/public/AppFramework/Http/Template/LinkMenuAction.php
@@ -29,7 +29,6 @@
 /**
  * Class LinkMenuAction
  *
- * @package OCP\AppFramework\Http\Template
  * @since 14.0.0
  */
 class LinkMenuAction extends SimpleMenuAction {

diff --git a/lib/public/AppFramework/Http/Template/PublicTemplateResponse.php b/lib/public/AppFramework/Http/Template/PublicTemplateResponse.php
@@ -31,7 +31,6 @@
 /**
  * Class PublicTemplateResponse
  *
- * @package OCP\AppFramework\Http\Template
  * @since 14.0.0
  */
 class PublicTemplateResponse extends TemplateResponse {

diff --git a/lib/public/AppFramework/Http/Template/SimpleMenuAction.php b/lib/public/AppFramework/Http/Template/SimpleMenuAction.php
@@ -29,7 +29,6 @@
 /**
  * Class SimpleMenuAction
  *
- * @package OCP\AppFramework\Http\Template
  * @since 14.0.0
  */
 class SimpleMenuAction implements IMenuAction {

diff --git a/lib/public/AppFramework/OCS/OCSBadRequestException.php b/lib/public/AppFramework/OCS/OCSBadRequestException.php
@@ -29,7 +29,6 @@
 /**
  * Class OCSBadRequestException
  *
- * @package OCP\AppFramework
  * @since 9.1.0
  */
 class OCSBadRequestException extends OCSException {

diff --git a/lib/public/AppFramework/OCS/OCSException.php b/lib/public/AppFramework/OCS/OCSException.php
@@ -29,7 +29,6 @@
 /**
  * Class OCSException
  *
- * @package OCP\AppFramework
  * @since 9.1.0
  */
 class OCSException extends Exception {

diff --git a/lib/public/AppFramework/OCS/OCSForbiddenException.php b/lib/public/AppFramework/OCS/OCSForbiddenException.php
@@ -29,7 +29,6 @@
 /**
  * Class OCSForbiddenException
  *
- * @package OCP\AppFramework
  * @since 9.1.0
  */
 class OCSForbiddenException extends OCSException {

diff --git a/lib/public/AppFramework/OCS/OCSNotFoundException.php b/lib/public/AppFramework/OCS/OCSNotFoundException.php
@@ -29,7 +29,6 @@
 /**
  * Class OCSNotFoundException
  *
- * @package OCP\AppFramework
  * @since 9.1.0
  */
 class OCSNotFoundException extends OCSException {

diff --git a/lib/public/AppFramework/QueryException.php b/lib/public/AppFramework/QueryException.php
@@ -35,7 +35,6 @@
  *
  * The class extends `NotFoundExceptionInterface` since 20.0.0
  *
- * @package OCP\AppFramework
  * @since 8.1.0
  * @deprecated 20.0.0 catch \Psr\Container\ContainerExceptionInterface
  */

diff --git a/lib/public/AppFramework/Utility/IControllerMethodReflector.php b/lib/public/AppFramework/Utility/IControllerMethodReflector.php
@@ -33,7 +33,6 @@
  *
  * Reads and parses annotations from doc comments
  *
- * @package OCP\AppFramework\Utility
  * @since 8.0.0
  */
 interface IControllerMethodReflector {

diff --git a/lib/public/Authentication/IApacheBackend.php b/lib/public/Authentication/IApacheBackend.php
@@ -36,7 +36,6 @@
 /**
  * Interface IApacheBackend
  *
- * @package OCP\Authentication
  * @since 6.0.0
  */
 interface IApacheBackend {

diff --git a/lib/public/BackgroundJob/IJob.php b/lib/public/BackgroundJob/IJob.php
@@ -32,7 +32,6 @@
 /**
  * Interface IJob
  *
- * @package OCP\BackgroundJob
  * @since 7.0.0
  */
 interface IJob {

diff --git a/lib/public/BackgroundJob/IJobList.php b/lib/public/BackgroundJob/IJobList.php
@@ -42,7 +42,6 @@
  * be specified in the constructor of the job by calling
  * $this->setInterval($interval) with $interval in seconds.
  *
- * @package OCP\BackgroundJob
  * @since 7.0.0
  */
 interface IJobList {

diff --git a/lib/public/Calendar/BackendTemporarilyUnavailableException.php b/lib/public/Calendar/BackendTemporarilyUnavailableException.php
@@ -27,7 +27,6 @@
 /**
  * Class BackendTemporarilyUnavailableException
  *
- * @package OCP\Calendar
  * @since 14.0.0
  */
 class BackendTemporarilyUnavailableException extends \Exception {

diff --git a/lib/public/Calendar/ICalendar.php b/lib/public/Calendar/ICalendar.php
@@ -26,7 +26,6 @@
 /**
  * Interface ICalendar
  *
- * @package OCP
  * @since 13.0.0
  */
 interface ICalendar {

diff --git a/lib/public/Calendar/IMetadataProvider.php b/lib/public/Calendar/IMetadataProvider.php
@@ -28,7 +28,6 @@
  *
  * Provider for metadata of a resource or a room
  *
- * @package OCP\Calendar
  * @since 17.0.0
  */
 interface IMetadataProvider {

diff --git a/lib/public/Calendar/Resource/IBackend.php b/lib/public/Calendar/Resource/IBackend.php
@@ -29,7 +29,6 @@
 /**
  * Interface IBackend
  *
- * @package OCP\Calendar\Resource
  * @since 14.0.0
  */
 interface IBackend {

diff --git a/lib/public/Calendar/Resource/IManager.php b/lib/public/Calendar/Resource/IManager.php
@@ -26,7 +26,6 @@
 /**
  * Interface IManager
  *
- * @package OCP\Calendar\Resource
  * @since 14.0.0
  */
 interface IManager {

diff --git a/lib/public/Calendar/Resource/IResource.php b/lib/public/Calendar/Resource/IResource.php
@@ -26,7 +26,6 @@
 /**
  * Interface IResource
  *
- * @package OCP\Calendar\Resource
  * @since 14.0.0
  */
 interface IResource {
-Original file line number
+Diff line change
@@ Expand Up / @@ -34,7 +34,6 @@ @@
      *
      * @since 15.0.0
      *
-     * @package OCP\Accounts
      */
     interface IAccountManager {
@@ Expand Down @@