Bug #90375
closed
resourceFactory->createFileReferenceObject not documented
0%
Description
TYPO3\CMS\Core\Resource\resourceFactory->createFileReferenceObject is not documented: https://api.typo3.org/9.5/class_t_y_p_o3_1_1_c_m_s_1_1_core_1_1_resource_1_1_resource_factory.html
Related to this issue,
The function is used as a "workaround" to create a new fileReference in Extbase-Context, see this example featured in the official TYPO3 documentation (https://docs.typo3.org/m/typo3/reference-coreapi/master/en-us/ApiOverview/Fal/UsingFal/ExamplesFileFolder.html#in-the-frontend-context): https://github.com/helhum/upload_example
Updated by Daniel Siepmann over 3 years ago
- Tracker changed from Task to Bug
- Category changed from File Abstraction Layer (FAL) to Documentation
- Status changed from New to Accepted
- Assignee set to Daniel Siepmann
api.typo3.org was not generated anymore.
This is now fixed and it also contains current master and 10.4 now.
The mentioned method still doesn't show up.
You can see the method for 10.4 here: https://github.com/TYPO3/TYPO3.CMS/blob/10.4/typo3/sysext/core/Classes/Resource/ResourceFactory.php#L622
It also shows up on https://api.typo3.org/master/_resource_factory_8php_source.html on line 610.
But you can't even link to the line. Looks like this and some more methods are not recognized for some reason.
Inside rendering the following error is logged:
error 22-Sep-2020 03:30:26 /mnt/doxygen/typo3/sysext/core/Classes/Resource/ResourceFactory.php:612: warning: documented symbol 'TYPO3\CMS\Core\Resource\ResourceFactory::createFileReferenceObject' was not declared or defined.
Further errors are logged for that file:
error 22-Sep-2020 03:30:26 /mnt/doxygen/typo3/sysext/core/Classes/Resource/ResourceFactory.php:42: warning: documented symbol 'TYPO3\CMS\Core\Resource\ResourceFactory::ResourceStorage[]' was not declared or defined. error 22-Sep-2020 03:30:26 /mnt/doxygen/typo3/sysext/core/Classes/Resource/ResourceFactory.php:47: warning: documented symbol 'Collection TYPO3\CMS\Core\Resource\ResourceFactory::AbstractFileCollection[]' was not declared or defined. error 22-Sep-2020 03:30:26 /mnt/doxygen/typo3/sysext/core/Classes/Resource/ResourceFactory.php:52: warning: documented symbol 'TYPO3\CMS\Core\Resource\ResourceFactory::File[]' was not declared or defined. error 22-Sep-2020 03:30:26 /mnt/doxygen/typo3/sysext/core/Classes/Resource/ResourceFactory.php:57: warning: documented symbol 'TYPO3\CMS\Core\Resource\ResourceFactory::FileReference[]' was not declared or defined. error 22-Sep-2020 03:30:26 /mnt/doxygen/typo3/sysext/core/Classes/Resource/ResourceFactory.php:64: warning: documented symbol 'TYPO3\CMS\Core\Resource\ResourceFactory::array' was not declared or defined. error 22-Sep-2020 03:30:26 /mnt/doxygen/typo3/sysext/core/Classes/Resource/ResourceFactory.php:69: warning: documented symbol 'TYPO3\CMS\Core\Resource\ResourceFactory::EventDispatcherInterface' was not declared or defined. error 22-Sep-2020 03:30:26 /mnt/doxygen/typo3/sysext/core/Classes/Resource/ResourceFactory.php:92: warning: documented symbol 'TYPO3\CMS\Core\Resource\ResourceFactory::getDriverObject' was not declared or defined. error 22-Sep-2020 03:30:26 /mnt/doxygen/typo3/sysext/core/Classes/Resource/ResourceFactory.php:111: warning: documented symbol 'TYPO3\CMS\Core\Resource\ResourceFactory::getDefaultStorage' was not declared or defined. error 22-Sep-2020 03:30:26 /mnt/doxygen/typo3/sysext/core/Classes/Resource/ResourceFactory.php:144: warning: documented symbol 'TYPO3\CMS\Core\Resource\ResourceFactory::getStorageObject' was not declared or defined. error 22-Sep-2020 03:30:26 /mnt/doxygen/typo3/sysext/core/Classes/Resource/ResourceFactory.php:171: warning: documented symbol 'BeforeResourceStorageInitializationEvent TYPO3\CMS\Core\Resource\ResourceFactory::$event' was not declared or defined. error 22-Sep-2020 03:30:26 /mnt/doxygen/typo3/sysext/core/Classes/Resource/ResourceFactory.php:222: warning: documented symbol 'TYPO3\CMS\Core\Resource\ResourceFactory::initializeLocalStorageCache' was not declared or defined. error 22-Sep-2020 03:30:26 /mnt/doxygen/typo3/sysext/core/Classes/Resource/ResourceFactory.php:224: warning: no uniquely matching class member found for error 22-Sep-2020 03:30:26 StorageRepository TYPO3\CMS\Core\Resource\ResourceFactory::$storageRepository error 22-Sep-2020 03:30:26 error 22-Sep-2020 03:30:26 /mnt/doxygen/typo3/sysext/core/Classes/Resource/ResourceFactory.php:298: warning: documented symbol 'TYPO3\CMS\Core\Resource\ResourceFactory::createCollectionObject' was not declared or defined. error 22-Sep-2020 03:30:26 /mnt/doxygen/typo3/sysext/core/Classes/Resource/ResourceFactory.php:301: warning: no uniquely matching class member found for error 22-Sep-2020 03:30:26 Collection FileCollectionRegistry TYPO3\CMS\Core\Resource\ResourceFactory::$registry error 22-Sep-2020 03:30:26 error 22-Sep-2020 03:30:26 /mnt/doxygen/typo3/sysext/core/Classes/Resource/ResourceFactory.php:562: warning: documented symbol 'TYPO3\CMS\Core\Resource\ResourceFactory::createFileObject' was not declared or defined.
And some more errors for other files.
The following is logged in addition for the file:
error 22-Sep-2020 03:31:15 /mnt/doxygen/typo3/sysext/core/Classes/Resource/ResourceFactory.php:256: warning: unexpected token in comment block while parsing the argument of command throws error 22-Sep-2020 03:31:15 /mnt/doxygen/typo3/sysext/core/Classes/Resource/ResourceFactory.php:343: warning: unexpected token in comment block while parsing the argument of command throws error 22-Sep-2020 03:31:15 /mnt/doxygen/typo3/sysext/core/Classes/Resource/ResourceFactory.php:370: warning: unexpected token in comment block while parsing the argument of command throws error 22-Sep-2020 03:31:15 /mnt/doxygen/typo3/sysext/core/Classes/Resource/ResourceFactory.php:574: warning: unexpected token in comment block while parsing the argument of command throws error 22-Sep-2020 03:31:15 /mnt/doxygen/typo3/sysext/core/Classes/Resource/ResourceFactory.php:483: warning: Found unknown command '@TODO' error 22-Sep-2020 03:31:15 /mnt/doxygen/typo3/sysext/core/Classes/Resource/ResourceFactory.php:670: warning: Found unknown command '\Indexer' error 22-Sep-2020 03:31:15 /mnt/doxygen/typo3/sysext/core/Classes/Resource/ResourceFactory.php:527: warning: unexpected token in comment block while parsing the argument of command throwsFurther relevant links:
Updated by Susanne Moog over 3 years ago
I analysed this further and fixed it:
The problem stems from /** @var Foo $foo */ comments in the code that doxygen tries to parse - any method that contained such a comment was not documented any more. We are now using a pre-input filter on the source code that removes these kinds of comments before parsing by doxygen (see https://github.com/TYPO3GmbH/doxygenapi/blob/master/all_filters.php).
Updated by Daniel Siepmann over 3 years ago
- Status changed from Accepted to Closed