Add php docs build script

[juliusknorr]

For nextcloud/documentation#1782

Adds a build script to build php api documentation on netlify using phpDocumentor. A preview can be found at https://nextcloud-server.netlify.app/

[ChristophWurst]

Adds a build script to build php api documentation on netlify using phpDocumentor. A preview can be found at https://nextcloud-server.netlify.app/

This looks amazing!

[rullzer]

@juliushaertl could you make sure that OC things don't get indexed? We don't want people using that ;)

[juliusknorr]

Yep, I'll have another look. Seems mainly caused by invalid @package annotations in lib/public:

ack @package lib/public | grep -v OCP 
lib/public/Share/IProviderFactory.php:31: * @package OC\Share20
lib/public/IGroupManager.php:46: * @package OC\Group
lib/public/IUserManager.php:47: * @package OC\User
lib/public/FullTextSearch/Model/IIndexDocument.php:44: * @package OC\FullTextSearch\Model
lib/public/Files/SimpleFS/InMemoryFile.php:35: * @package OC\Files\SimpleFS

[rullzer]

Yep, I'll have another look. Seems mainly caused by invalid @package annotations in lib/public:

ack @package lib/public | grep -v OCP 
lib/public/Share/IProviderFactory.php:31: * @package OC\Share20
lib/public/IGroupManager.php:46: * @package OC\Group
lib/public/IUserManager.php:47: * @package OC\User
lib/public/FullTextSearch/Model/IIndexDocument.php:44: * @package OC\FullTextSearch\Model
lib/public/Files/SimpleFS/InMemoryFile.php:35: * @package OC\Files\SimpleFS

ah then we just fix those :)

[kesselb]

https://nextcloud-server.netlify.app/packages/ocp-appframeworkanyapplicationmustinheritthiscall

😂 (Nothing wrong with it. I just laughed about the long package name)

[juliusknorr]

Pushed a fix. As a general thing I think we could just drop all @package declarations since they just are equal to the namespace where they are used.

https://docs.phpdoc.org/latest/references/phpdoc/tags/package.html

The @package tag can be used as a counterpart or supplement to Namespaces. Namespaces provide a functional subdivision of Structural Elements where the @package tag can provide a logical subdivision in which way the elements can be grouped with a different hierarchy.

Since we don't introduce any different structure removing them will make the docs output a lot cleaner with out having duplicated hierarchies.

[ChristophWurst]

Pushed a fix. As a general thing I think we could just drop all @package declarations since they just are equal to the namespace where they are used.

I think we only have them because phpstorm adds those when you create a new class

[kesselb]

server/lib/public/App/ManagerEvent.php

Line 32 in cb2695d

* @package OCP\APP

Mind to remove?

To fix App and APP.

[juliusknorr]

Pushed a commit to remove all the @package annotations in lib/public now. Feels a lot cleaner not having any in the docs now.

[faily-bot]

🤖 beep boop beep 🤖

Here are the logs for the failed build:

Status of 32344: failure

acceptance-app-files

• tests/acceptance/features/app-files.feature:262

Show full log

  Scenario: unmarking a file as favorite causes the file list to be sorted again                          # /drone/src/tests/acceptance/features/app-files.feature:262
    Given I am logged in                                                                                  # LoginPageContext::iAmLoggedIn()
    And I create a new folder named "A name alphabetically lower than welcome.txt"                        # FileListContext::iCreateANewFolderNamed()
    And I see that "A name alphabetically lower than welcome.txt" precedes "welcome.txt" in the file list # FileListContext::iSeeThatPrecedesInTheFileList()
    And I close the details view                                                                          # FilesAppContext::iCloseTheDetailsView()
    And I see that the details view is closed                                                             # FilesAppContext::iSeeThatTheDetailsViewIsClosed()
    And I mark "welcome.txt" as favorite                                                                  # FileListContext::iMarkAsFavorite()
    And I see that "welcome.txt" is marked as favorite                                                    # FileListContext::iSeeThatIsMarkedAsFavorite()
    And I see that "welcome.txt" precedes "A name alphabetically lower than welcome.txt" in the file list # FileListContext::iSeeThatPrecedesInTheFileList()
    When I unmark "welcome.txt" as favorite                                                               # FileListContext::iUnmarkAsFavorite()
    Then I see that "welcome.txt" is not marked as favorite                                               # FileListContext::iSeeThatIsNotMarkedAsFavorite()
      Not favorited state icon for file welcome.txt in file list could not be found after 100 seconds (NoSuchElementException)
    And I see that "A name alphabetically lower than welcome.txt" precedes "welcome.txt" in the file list # FileListContext::iSeeThatPrecedesInTheFileList()