Merge pull request #22448 from nextcloud/stable19-phpdoc

[stable19]  Add php docs build script
This commit is contained in:
Roeland Jago Douma 2020-08-27 15:35:34 +02:00 committed by GitHub
commit d5943a5f75
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
224 changed files with 11 additions and 224 deletions

11
build/phpDocumentor.sh Executable file
View File

@ -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 ($BRANCH)"

View File

@ -32,7 +32,6 @@ use OCP\IUser;
* Interface IAccount
*
* @since 15.0.0
* @package OCP\Accounts
*/
interface IAccount extends \JsonSerializable {

View File

@ -34,7 +34,6 @@ use OCP\IUser;
*
* @since 15.0.0
*
* @package OCP\Accounts
*/
interface IAccountManager {

View File

@ -29,7 +29,6 @@ namespace OCP\Accounts;
/**
* Interface IAccountProperty
*
* @package OCP\Account
* @since 15.0.0
*/
interface IAccountProperty extends \JsonSerializable {

View File

@ -29,7 +29,6 @@ namespace OCP\Accounts;
*
* @since 15.0.0
*
* @package OCP\Accounts
*/
class PropertyDoesNotExistException extends \Exception {

View File

@ -36,7 +36,6 @@ namespace OCP\Activity;
/**
* Interface IConsumer
*
* @package OCP\Activity
* @since 6.0.0
*/
interface IConsumer {

View File

@ -38,7 +38,6 @@ namespace OCP\Activity;
/**
* Interface IEvent
*
* @package OCP\Activity
* @since 8.2.0
*/
interface IEvent {

View File

@ -26,7 +26,6 @@ namespace OCP\Activity;
/**
* Interface EventMerger
*
* @package OCP\Activity
* @since 11.0
*/
interface IEventMerger {

View File

@ -28,7 +28,6 @@ namespace OCP\Activity;
/**
* Interface IExtension
*
* @package OCP\Activity
* @since 8.0.0
*/
interface IExtension {

View File

@ -26,7 +26,6 @@ namespace OCP\Activity;
/**
* Interface IFilter
*
* @package OCP\Activity
* @since 11.0.0
*/
interface IFilter {

View File

@ -31,7 +31,6 @@ namespace OCP\Activity;
/**
* Interface IManager
*
* @package OCP\Activity
* @since 6.0.0
*/
interface IManager {

View File

@ -26,7 +26,6 @@ namespace OCP\Activity;
/**
* Interface IProvider
*
* @package OCP\Activity
* @since 11.0.0
*/
interface IProvider {

View File

@ -26,7 +26,6 @@ namespace OCP\Activity;
/**
* Interface ISetting
*
* @package OCP\Activity
* @since 11.0.0
*/
interface ISetting {

View File

@ -27,7 +27,6 @@ namespace OCP\App;
/**
* Class AppPathNotFoundException
*
* @package OCP\App
* @since 11.0.0
*/
class AppPathNotFoundException extends \Exception {

View File

@ -37,7 +37,6 @@ use OCP\IUser;
/**
* Interface IAppManager
*
* @package OCP\App
* @since 8.0.0
*/
interface IAppManager {

View File

@ -29,7 +29,6 @@ use OCP\EventDispatcher\Event;
/**
* Class ManagerEvent
*
* @package OCP\APP
* @since 9.0.0
*/
class ManagerEvent extends Event {

View File

@ -45,7 +45,6 @@ use OCP\Route\IRouter;
/**
* Class App
* @package OCP\AppFramework
*
* Any application must inherit this call - all controller instances to be used are
* to be registered using IContainer::registerService

View File

@ -38,7 +38,6 @@ namespace OCP\AppFramework\Http;
*
* This class allows unsafe-eval of javascript and unsafe-inline of CSS.
*
* @package OCP\AppFramework\Http
* @since 8.1.0
*/
class ContentSecurityPolicy extends EmptyContentSecurityPolicy {

View File

@ -30,7 +30,6 @@ use OCP\AppFramework\Http;
/**
* Class DataDisplayResponse
*
* @package OCP\AppFramework\Http
* @since 8.1.0
*/
class DataDisplayResponse extends Response {

View File

@ -27,7 +27,6 @@ namespace OCP\AppFramework\Http;
/**
* Class DataDownloadResponse
*
* @package OCP\AppFramework\Http
* @since 8.0.0
*/
class DataDownloadResponse extends DownloadResponse {

View File

@ -35,7 +35,6 @@ namespace OCP\AppFramework\Http;
* As alternative with sane exemptions look at ContentSecurityPolicy
*
* @see \OCP\AppFramework\Http\ContentSecurityPolicy
* @package OCP\AppFramework\Http
* @since 9.0.0
*/
class EmptyContentSecurityPolicy {

View File

@ -34,7 +34,6 @@ namespace OCP\AppFramework\Http;
* As alternative with sane exemptions look at FeaturePolicy
*
* @see \OCP\AppFramework\Http\FeaturePolicy
* @package OCP\AppFramework\Http
* @since 17.0.0
*/
class EmptyFeaturePolicy {

View File

@ -35,7 +35,6 @@ namespace OCP\AppFramework\Http;
* 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 {

View File

@ -28,7 +28,6 @@ use OCP\AppFramework\Http;
/**
* Class FileDisplayResponse
*
* @package OCP\AppFramework\Http
* @since 11.0.0
*/
class FileDisplayResponse extends Response implements ICallbackResponse {

View File

@ -28,7 +28,6 @@ namespace OCP\AppFramework\Http;
/**
* Interface ICallbackResponse
*
* @package OCP\AppFramework\Http
* @since 8.1.0
*/
interface ICallbackResponse {

View File

@ -32,7 +32,6 @@ use OCP\AppFramework\Http;
/**
* Class StreamResponse
*
* @package OCP\AppFramework\Http
* @since 8.1.0
*/
class StreamResponse extends Response implements ICallbackResponse {

View File

@ -39,7 +39,6 @@ namespace OCP\AppFramework\Http;
* 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
*/

View File

@ -39,7 +39,6 @@ namespace OCP\AppFramework\Http;
* 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
*/

View File

@ -39,7 +39,6 @@ namespace OCP\AppFramework\Http;
* 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
*/

View File

@ -31,7 +31,6 @@ use OCP\Util;
/**
* Class LinkMenuAction
*
* @package OCP\AppFramework\Http\Template
* @since 14.0.0
*/
class ExternalShareMenuAction extends SimpleMenuAction {

View File

@ -27,7 +27,6 @@ namespace OCP\AppFramework\Http\Template;
/**
* Interface IMenuAction
*
* @package OCP\AppFramework\Http\Template
* @since 14.0
*/
interface IMenuAction {

View File

@ -29,7 +29,6 @@ use OCP\Util;
/**
* Class LinkMenuAction
*
* @package OCP\AppFramework\Http\Template
* @since 14.0.0
*/
class LinkMenuAction extends SimpleMenuAction {

View File

@ -31,7 +31,6 @@ use OCP\AppFramework\Http\TemplateResponse;
/**
* Class PublicTemplateResponse
*
* @package OCP\AppFramework\Http\Template
* @since 14.0.0
*/
class PublicTemplateResponse extends TemplateResponse {

View File

@ -29,7 +29,6 @@ use OCP\Util;
/**
* Class SimpleMenuAction
*
* @package OCP\AppFramework\Http\Template
* @since 14.0.0
*/
class SimpleMenuAction implements IMenuAction {

View File

@ -30,7 +30,6 @@ use OCP\IContainer;
/**
* Class IAppContainer
* @package OCP\AppFramework
*
* This container interface provides short cuts for app developers to access predefined app service.
* @since 6.0.0

View File

@ -29,7 +29,6 @@ use OCP\AppFramework\Http;
/**
* Class OCSBadRequestException
*
* @package OCP\AppFramework
* @since 9.1.0
*/
class OCSBadRequestException extends OCSException {

View File

@ -29,7 +29,6 @@ use Exception;
/**
* Class OCSException
*
* @package OCP\AppFramework
* @since 9.1.0
*/
class OCSException extends Exception {

View File

@ -29,7 +29,6 @@ use OCP\AppFramework\Http;
/**
* Class OCSForbiddenException
*
* @package OCP\AppFramework
* @since 9.1.0
*/
class OCSForbiddenException extends OCSException {

View File

@ -29,7 +29,6 @@ use OCP\AppFramework\Http;
/**
* Class OCSNotFoundException
*
* @package OCP\AppFramework
* @since 9.1.0
*/
class OCSNotFoundException extends OCSException {

View File

@ -29,7 +29,6 @@ use Exception;
/**
* Class QueryException
*
* @package OCP\AppFramework
* @since 8.1.0
*/
class QueryException extends Exception {

View File

@ -33,7 +33,6 @@ namespace OCP\AppFramework\Utility;
*
* Reads and parses annotations from doc comments
*
* @package OCP\AppFramework\Utility
* @since 8.0.0
*/
interface IControllerMethodReflector {

View File

@ -31,7 +31,6 @@ use OCP\EventDispatcher\Event;
/**
* Class LoginFailedEvent
*
* @package OCP\Authentication\Events
*
* @since 19.0.0
*/

View File

@ -36,7 +36,6 @@ namespace OCP\Authentication;
/**
* Interface IApacheBackend
*
* @package OCP\Authentication
* @since 6.0.0
*/
interface IApacheBackend {

View File

@ -31,7 +31,6 @@ use OCP\ILogger;
/**
* Interface IJob
*
* @package OCP\BackgroundJob
* @since 7.0.0
*/
interface IJob {

View File

@ -42,7 +42,6 @@ namespace OCP\BackgroundJob;
* 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 {

View File

@ -27,7 +27,6 @@ namespace OCP\Calendar;
/**
* Class BackendTemporarilyUnavailableException
*
* @package OCP\Calendar
* @since 14.0.0
*/
class BackendTemporarilyUnavailableException extends \Exception {

View File

@ -26,7 +26,6 @@ namespace OCP\Calendar;
/**
* Interface ICalendar
*
* @package OCP
* @since 13.0.0
*/
interface ICalendar {

View File

@ -28,7 +28,6 @@ namespace OCP\Calendar;
*
* Provider for metadata of a resource or a room
*
* @package OCP\Calendar
* @since 17.0.0
*/
interface IMetadataProvider {

View File

@ -29,7 +29,6 @@ use OCP\Calendar\BackendTemporarilyUnavailableException;
/**
* Interface IBackend
*
* @package OCP\Calendar\Resource
* @since 14.0.0
*/
interface IBackend {

View File

@ -26,7 +26,6 @@ namespace OCP\Calendar\Resource;
/**
* Interface IManager
*
* @package OCP\Calendar\Resource
* @since 14.0.0
*/
interface IManager {

View File

@ -26,7 +26,6 @@ namespace OCP\Calendar\Resource;
/**
* Interface IResource
*
* @package OCP\Calendar\Resource
* @since 14.0.0
*/
interface IResource {

View File

@ -30,7 +30,6 @@ namespace OCP\Calendar\Resource;
* Resource Backends are not limited to this list and can provide
* any metadata they want.
*
* @package OCP\Calendar\Resource
* @since 17.0.0
*/
interface IResourceMetadata {

View File

@ -29,7 +29,6 @@ use OCP\Calendar\BackendTemporarilyUnavailableException;
/**
* Interface IBackend
*
* @package OCP\Calendar\Room
* @since 14.0.0
*/
interface IBackend {

View File

@ -26,7 +26,6 @@ namespace OCP\Calendar\Room;
/**
* Interface IManager
*
* @package OCP\Calendar\Room
* @since 14.0.0
*/
interface IManager {

View File

@ -26,7 +26,6 @@ namespace OCP\Calendar\Room;
/**
* Interface IRoom
*
* @package OCP\Calendar\Room
* @since 14.0.0
*/
interface IRoom {

View File

@ -30,7 +30,6 @@ namespace OCP\Calendar\Room;
* Room Backends are not limited to this list and can provide
* any metadata they want.
*
* @package OCP\Calendar\Room
* @since 17.0.0
*/
interface IRoomMetadata {

View File

@ -26,7 +26,6 @@ namespace OCP\Collaboration\AutoComplete;
/**
* Interface IManager
*
* @package OCP\Collaboration\AutoComplete
* @since 13.0.0
*/
interface IManager {

View File

@ -28,7 +28,6 @@ namespace OCP\Collaboration\AutoComplete;
*
* Sorts the list of .e.g users for auto completion
*
* @package OCP\Collaboration\AutoComplete
* @since 13.0.0
*/
interface ISorter {

View File

@ -26,7 +26,6 @@ namespace OCP\Collaboration\Collaborators;
/**
* Interface ISearch
*
* @package OCP\Collaboration\Collaborators
* @since 13.0.0
*/
interface ISearch {

View File

@ -26,7 +26,6 @@ namespace OCP\Collaboration\Collaborators;
/**
* Interface ISearchPlugin
*
* @package OCP\Collaboration\Collaborators
* @since 13.0.0
*/
interface ISearchPlugin {

View File

@ -26,7 +26,6 @@ namespace OCP\Collaboration\Collaborators;
/**
* Interface ISearchResult
*
* @package OCP\Collaboration\Collaborators
* @since 13.0.0
*/
interface ISearchResult {

View File

@ -28,7 +28,6 @@ namespace OCP\Collaboration\Collaborators;
/**
* Class SearchResultType
*
* @package OCP\Collaboration\Collaborators
* @since 13.0.0
*/
class SearchResultType {

View File

@ -26,7 +26,6 @@ namespace OCP\Command;
/**
* Interface IBus
*
* @package OCP\Command
* @since 8.1.0
*/
interface IBus {

View File

@ -26,7 +26,6 @@ namespace OCP\Command;
/**
* Interface ICommand
*
* @package OCP\Command
* @since 8.1.0
*/
interface ICommand {

View File

@ -29,7 +29,6 @@ use OCP\EventDispatcher\Event;
/**
* Class CommentsEntityEvent
*
* @package OCP\Comments
* @since 9.1.0
*/
class CommentsEntityEvent extends Event {

View File

@ -29,7 +29,6 @@ use OCP\EventDispatcher\Event;
/**
* Class CommentsEvent
*
* @package OCP\Comments
* @since 9.0.0
*/
class CommentsEvent extends Event {

View File

@ -31,7 +31,6 @@ namespace OCP\Comments;
*
* This class represents a comment
*
* @package OCP\Comments
* @since 9.0.0
*/
interface IComment {

View File

@ -27,7 +27,6 @@ namespace OCP\Comments;
/**
* Interface ICommentsEventHandler
*
* @package OCP\Comments
* @since 11.0.0
*/
interface ICommentsEventHandler {

View File

@ -35,7 +35,6 @@ use OCP\IUser;
*
* This class manages the access to comments
*
* @package OCP\Comments
* @since 9.0.0
*/
interface ICommentsManager {

View File

@ -33,7 +33,6 @@ use OCP\IServerContainer;
* This class is responsible for instantiating and returning an ICommentsManager
* instance.
*
* @package OCP\Comments
* @since 9.0.0
*/
interface ICommentsManagerFactory {

View File

@ -29,7 +29,6 @@ use OCP\EventDispatcher\Event;
/**
* Class ConsoleEvent
*
* @package OCP\Console
* @since 9.0.0
*/
class ConsoleEvent extends Event {

View File

@ -33,7 +33,6 @@ namespace OCP;
/**
* Class Constants
*
* @package OCP
* @since 8.0.0
*/
class Constants {

View File

@ -26,7 +26,6 @@ namespace OCP\DB;
/**
* Interface ISchemaWrapper
*
* @package OCP\DB
* @since 13.0.0
*/
interface ISchemaWrapper {

View File

@ -31,7 +31,6 @@ namespace OCP\Dashboard\Exceptions;
*
* Class DashboardAppNotAvailableException
*
* @package OCP\Dashboard\Exceptions
*/
class DashboardAppNotAvailableException extends \Exception {
}

View File

@ -39,7 +39,6 @@ use OCP\Dashboard\Service\IWidgetsService;
*
* @since 15.0.0
*
* @package OCP\Dashboard
*/
interface IDashboardManager {

View File

@ -46,7 +46,6 @@ use OCP\Dashboard\Model\WidgetTemplate;
*
* @since 15.0.0
*
* @package OCP\Dashboard
*/
interface IDashboardWidget {

View File

@ -37,7 +37,6 @@ use OCP\Dashboard\IDashboardWidget;
*
* @since 15.0.0
*
* @package OCP\Dashboard\Model
*/
interface IWidgetConfig {

View File

@ -39,7 +39,6 @@ use OCP\Dashboard\IDashboardWidget;
*
* @since 15.0.0
*
* @package OCP\Dashboard\Model
*/
interface IWidgetRequest {

View File

@ -46,7 +46,6 @@ use JsonSerializable;
*
* @since 15.0.0
*
* @package OCP\Dashboard\Model
*/
final class WidgetSetting implements JsonSerializable {
public const TYPE_INPUT = 'input';

View File

@ -39,7 +39,6 @@ use JsonSerializable;
*
* @since 15.0.0
*
* @package OCP\Dashboard\Model
*/
final class WidgetSetup implements JsonSerializable {
public const SIZE_TYPE_MIN = 'min';

View File

@ -38,7 +38,6 @@ use JsonSerializable;
*
* @since 15.0.0
*
* @package OCP\Dashboard\Model
*/
final class WidgetTemplate implements JsonSerializable {

View File

@ -36,7 +36,6 @@ use OCP\Dashboard\IDashboardManager;
*
* @since 15.0.0
*
* @package OCP\Dashboard\Service
*/
interface IEventsService {

View File

@ -37,7 +37,6 @@ use OCP\Dashboard\Model\IWidgetConfig;
*
* @since 15.0.0
*
* @package OCP\Dashboard\Service
*/
interface IWidgetsService {

View File

@ -26,7 +26,6 @@ namespace OCP\Diagnostics;
/**
* Interface IEvent
*
* @package OCP\Diagnostics
* @since 8.0.0
*/
interface IEvent {

View File

@ -27,7 +27,6 @@ namespace OCP\Diagnostics;
/**
* Interface IEventLogger
*
* @package OCP\Diagnostics
* @since 8.0.0
*/
interface IEventLogger {

View File

@ -28,7 +28,6 @@ namespace OCP\Diagnostics;
/**
* Interface IQuery
*
* @package OCP\Diagnostics
* @since 8.0.0
*/
interface IQuery {

View File

@ -31,7 +31,6 @@ use Doctrine\DBAL\Logging\SQLLogger;
/**
* Interface IQueryLogger
*
* @package OCP\Diagnostics
* @since 8.0.0
*/
interface IQueryLogger extends SQLLogger {

View File

@ -28,7 +28,6 @@ use JsonSerializable;
/**
* Class ATemplate
*
* @package OCP\DirectEditing
* @since 18.0.0
*/
abstract class ATemplate implements JsonSerializable {

View File

@ -33,7 +33,6 @@ use RuntimeException;
/**
* Interface IManager
*
* @package OCP\DirectEditing
* @since 18.0.0
*/
interface IManager {

View File

@ -32,7 +32,6 @@ use OC\HintException;
/**
* Class GenericEncryptionException
*
* @package OCP\Encryption\Exceptions
* @since 8.1.0
*/
class GenericEncryptionException extends HintException {

View File

@ -33,7 +33,6 @@ use Symfony\Component\Console\Output\OutputInterface;
/**
* Interface IEncryptionModule
*
* @package OCP\Encryption
* @since 8.1.0
*/
interface IEncryptionModule {

View File

@ -27,7 +27,6 @@ namespace OCP\Encryption;
/**
* Interface IFile
*
* @package OCP\Encryption
* @since 8.1.0
*/
interface IFile {

View File

@ -29,7 +29,6 @@ namespace OCP\Encryption\Keys;
/**
* Interface IStorage
*
* @package OCP\Encryption\Keys
* @since 8.1.0
*/
interface IStorage {

View File

@ -39,7 +39,6 @@ use function array_key_exists;
* convenience reimplementation of \Symfony\Component\GenericEvent against
* \OCP\EventDispatcher\Event
*
* @package OCP\EventDispatcher
* @since 18.0.0
*/
class GenericEvent extends Event implements ArrayAccess, IteratorAggregate {

View File

@ -28,7 +28,6 @@ use OC\HintException;
/**
* Class ActionNotSupportedException
*
* @package OCP\Federation\Exceptions
*
* @since 14.0.0
*/

View File

@ -28,7 +28,6 @@ use OC\HintException;
/**
* Class AuthenticationFailedException
*
* @package OCP\Federation\Exceptions
*
* @since 14.0.0
*/

View File

@ -28,7 +28,6 @@ use OC\HintException;
/**
* Class BadRequestException
*
* @package OCP\Federation\Exceptions
*
* @since 14.0.0
*/

View File

@ -30,7 +30,6 @@ use OC\HintException;
/**
* Class ProviderAlreadyExistsException
*
* @package OCP\Federation\Exceptions
*
* @since 14.0.0
*/

View File

@ -29,7 +29,6 @@ use OCP\AppFramework\Http;
/**
* Class ProviderCouldNotAddShareException
*
* @package OCP\Federation\Exceptions
*
* @since 14.0.0
*/

View File

@ -28,7 +28,6 @@ use OC\HintException;
/**
* Class ProviderDoesNotExistsException
*
* @package OCP\Federation\Exceptions
*
* @since 14.0.0
*/

Some files were not shown because too many files have changed in this diff Show More