Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add php docs build script #22432

Merged
merged 3 commits into from
Aug 26, 2020
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 11 additions & 0 deletions build/phpDocumentor.sh
Original file line number Diff line number Diff line change
@@ -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`)"
1 change: 0 additions & 1 deletion lib/public/Accounts/IAccount.php
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@
* Interface IAccount
*
* @since 15.0.0
* @package OCP\Accounts
*/
interface IAccount extends \JsonSerializable {

Expand Down
1 change: 0 additions & 1 deletion lib/public/Accounts/IAccountManager.php
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@
*
* @since 15.0.0
*
* @package OCP\Accounts
*/
interface IAccountManager {

Expand Down
1 change: 0 additions & 1 deletion lib/public/Accounts/IAccountProperty.php
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@
/**
* Interface IAccountProperty
*
* @package OCP\Account
* @since 15.0.0
*/
interface IAccountProperty extends \JsonSerializable {
Expand Down
1 change: 0 additions & 1 deletion lib/public/Accounts/PropertyDoesNotExistException.php
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@
*
* @since 15.0.0
*
* @package OCP\Accounts
*/
class PropertyDoesNotExistException extends \Exception {

Expand Down
1 change: 0 additions & 1 deletion lib/public/Activity/IConsumer.php
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@
/**
* Interface IConsumer
*
* @package OCP\Activity
* @since 6.0.0
*/
interface IConsumer {
Expand Down
1 change: 0 additions & 1 deletion lib/public/Activity/IEvent.php
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,6 @@
/**
* Interface IEvent
*
* @package OCP\Activity
* @since 8.2.0
*/
interface IEvent {
Expand Down
1 change: 0 additions & 1 deletion lib/public/Activity/IEventMerger.php
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
/**
* Interface EventMerger
*
* @package OCP\Activity
* @since 11.0
*/
interface IEventMerger {
Expand Down
1 change: 0 additions & 1 deletion lib/public/Activity/IExtension.php
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@
/**
* Interface IExtension
*
* @package OCP\Activity
* @since 8.0.0
*/
interface IExtension {
Expand Down
1 change: 0 additions & 1 deletion lib/public/Activity/IFilter.php
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
/**
* Interface IFilter
*
* @package OCP\Activity
* @since 11.0.0
*/
interface IFilter {
Expand Down
1 change: 0 additions & 1 deletion lib/public/Activity/IManager.php
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@
/**
* Interface IManager
*
* @package OCP\Activity
* @since 6.0.0
*/
interface IManager {
Expand Down
1 change: 0 additions & 1 deletion lib/public/Activity/IProvider.php
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
/**
* Interface IProvider
*
* @package OCP\Activity
* @since 11.0.0
*/
interface IProvider {
Expand Down
1 change: 0 additions & 1 deletion lib/public/Activity/ISetting.php
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
/**
* Interface ISetting
*
* @package OCP\Activity
* @since 11.0.0
*/
interface ISetting {
Expand Down
1 change: 0 additions & 1 deletion lib/public/App/AppPathNotFoundException.php
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@
/**
* Class AppPathNotFoundException
*
* @package OCP\App
* @since 11.0.0
*/
class AppPathNotFoundException extends \Exception {
Expand Down
1 change: 0 additions & 1 deletion lib/public/App/IAppManager.php
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,6 @@
/**
* Interface IAppManager
*
* @package OCP\App
* @since 8.0.0
*/
interface IAppManager {
Expand Down
1 change: 0 additions & 1 deletion lib/public/App/ManagerEvent.php
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@
/**
* Class ManagerEvent
*
* @package OCP\APP
* @since 9.0.0
*/
class ManagerEvent extends Event {
Expand Down
1 change: 0 additions & 1 deletion lib/public/AppFramework/App.php
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,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
Expand Down
1 change: 0 additions & 1 deletion lib/public/AppFramework/Http/ContentSecurityPolicy.php
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
1 change: 0 additions & 1 deletion lib/public/AppFramework/Http/DataDisplayResponse.php
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,6 @@
/**
* Class DataDisplayResponse
*
* @package OCP\AppFramework\Http
* @since 8.1.0
*/
class DataDisplayResponse extends Response {
Expand Down
1 change: 0 additions & 1 deletion lib/public/AppFramework/Http/DataDownloadResponse.php
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@
/**
* Class DataDownloadResponse
*
* @package OCP\AppFramework\Http
* @since 8.0.0
*/
class DataDownloadResponse extends DownloadResponse {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
1 change: 0 additions & 1 deletion lib/public/AppFramework/Http/EmptyFeaturePolicy.php
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
1 change: 0 additions & 1 deletion lib/public/AppFramework/Http/FeaturePolicy.php
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
1 change: 0 additions & 1 deletion lib/public/AppFramework/Http/FileDisplayResponse.php
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@
/**
* Class FileDisplayResponse
*
* @package OCP\AppFramework\Http
* @since 11.0.0
*/
class FileDisplayResponse extends Response implements ICallbackResponse {
Expand Down
1 change: 0 additions & 1 deletion lib/public/AppFramework/Http/ICallbackResponse.php
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@
/**
* Interface ICallbackResponse
*
* @package OCP\AppFramework\Http
* @since 8.1.0
*/
interface ICallbackResponse {
Expand Down
1 change: 0 additions & 1 deletion lib/public/AppFramework/Http/StreamResponse.php
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,6 @@
/**
* Class StreamResponse
*
* @package OCP\AppFramework\Http
* @since 8.1.0
*/
class StreamResponse extends Response implements ICallbackResponse {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@
/**
* Class LinkMenuAction
*
* @package OCP\AppFramework\Http\Template
* @since 14.0.0
*/
class ExternalShareMenuAction extends SimpleMenuAction {
Expand Down
1 change: 0 additions & 1 deletion lib/public/AppFramework/Http/Template/IMenuAction.php
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@
/**
* Interface IMenuAction
*
* @package OCP\AppFramework\Http\Template
* @since 14.0
*/
interface IMenuAction {
Expand Down
1 change: 0 additions & 1 deletion lib/public/AppFramework/Http/Template/LinkMenuAction.php
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@
/**
* Class LinkMenuAction
*
* @package OCP\AppFramework\Http\Template
* @since 14.0.0
*/
class LinkMenuAction extends SimpleMenuAction {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@
/**
* Class PublicTemplateResponse
*
* @package OCP\AppFramework\Http\Template
* @since 14.0.0
*/
class PublicTemplateResponse extends TemplateResponse {
Expand Down
1 change: 0 additions & 1 deletion lib/public/AppFramework/Http/Template/SimpleMenuAction.php
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@
/**
* Class SimpleMenuAction
*
* @package OCP\AppFramework\Http\Template
* @since 14.0.0
*/
class SimpleMenuAction implements IMenuAction {
Expand Down
1 change: 0 additions & 1 deletion lib/public/AppFramework/OCS/OCSBadRequestException.php
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@
/**
* Class OCSBadRequestException
*
* @package OCP\AppFramework
* @since 9.1.0
*/
class OCSBadRequestException extends OCSException {
Expand Down
1 change: 0 additions & 1 deletion lib/public/AppFramework/OCS/OCSException.php
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@
/**
* Class OCSException
*
* @package OCP\AppFramework
* @since 9.1.0
*/
class OCSException extends Exception {
Expand Down
1 change: 0 additions & 1 deletion lib/public/AppFramework/OCS/OCSForbiddenException.php
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@
/**
* Class OCSForbiddenException
*
* @package OCP\AppFramework
* @since 9.1.0
*/
class OCSForbiddenException extends OCSException {
Expand Down
1 change: 0 additions & 1 deletion lib/public/AppFramework/OCS/OCSNotFoundException.php
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@
/**
* Class OCSNotFoundException
*
* @package OCP\AppFramework
* @since 9.1.0
*/
class OCSNotFoundException extends OCSException {
Expand Down
1 change: 0 additions & 1 deletion lib/public/AppFramework/QueryException.php
Original file line number Diff line number Diff line change
Expand Up @@ -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
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,6 @@
*
* Reads and parses annotations from doc comments
*
* @package OCP\AppFramework\Utility
* @since 8.0.0
*/
interface IControllerMethodReflector {
Expand Down
1 change: 0 additions & 1 deletion lib/public/Authentication/IApacheBackend.php
Original file line number Diff line number Diff line change
Expand Up @@ -36,7 +36,6 @@
/**
* Interface IApacheBackend
*
* @package OCP\Authentication
* @since 6.0.0
*/
interface IApacheBackend {
Expand Down
1 change: 0 additions & 1 deletion lib/public/BackgroundJob/IJob.php
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,6 @@
/**
* Interface IJob
*
* @package OCP\BackgroundJob
* @since 7.0.0
*/
interface IJob {
Expand Down
1 change: 0 additions & 1 deletion lib/public/BackgroundJob/IJobList.php
Original file line number Diff line number Diff line change
Expand Up @@ -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 {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,6 @@
/**
* Class BackendTemporarilyUnavailableException
*
* @package OCP\Calendar
* @since 14.0.0
*/
class BackendTemporarilyUnavailableException extends \Exception {
Expand Down
1 change: 0 additions & 1 deletion lib/public/Calendar/ICalendar.php
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
/**
* Interface ICalendar
*
* @package OCP
* @since 13.0.0
*/
interface ICalendar {
Expand Down
1 change: 0 additions & 1 deletion lib/public/Calendar/IMetadataProvider.php
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,6 @@
*
* Provider for metadata of a resource or a room
*
* @package OCP\Calendar
* @since 17.0.0
*/
interface IMetadataProvider {
Expand Down
1 change: 0 additions & 1 deletion lib/public/Calendar/Resource/IBackend.php
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,6 @@
/**
* Interface IBackend
*
* @package OCP\Calendar\Resource
* @since 14.0.0
*/
interface IBackend {
Expand Down
1 change: 0 additions & 1 deletion lib/public/Calendar/Resource/IManager.php
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
/**
* Interface IManager
*
* @package OCP\Calendar\Resource
* @since 14.0.0
*/
interface IManager {
Expand Down
1 change: 0 additions & 1 deletion lib/public/Calendar/Resource/IResource.php
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,6 @@
/**
* Interface IResource
*
* @package OCP\Calendar\Resource
* @since 14.0.0
*/
interface IResource {
Expand Down
Loading