search

symfony / symfony-docs

The Symfony documentation
https://symfony.com/doc
Other
2.15k stars 5.1k forks source link

API Documentation for all classes, attributes and methods #19944

Closed Maniues closed 1 month ago

Maniues commented 1 month ago

When using Symfony, it would be much better if I could find available methods for given classes, as is the case in many frameworks (api docs, api reference), similar to the Java Api using JavaDoc or the documentation like in Laravel

I've seen something like this for Symfony before, but it doesn't look official or current: https://phpdox.net/demo/Symfony2/index.xhtml

Is this documentation available?

Maniues commented 1 month ago

I discovered that there was a documentation for Symfony at api.symfony.com, but it is not available at the moment. Why?

Maniues commented 1 month ago

After reading some of the posts on X.com, I see that api.symfony.com has been closed. For me, API Docs are important, and they certainly make it easier to find methods in classes, but I understand that not many people may want to use them, especially advanced ones.

For beginners or those who prefer such documentation: consider generating the documentation yourself using phpdocumentor, doxygen or doctum (a fork of sami, the former generator for api.symfony.com).

Perhaps if I generate some documentation, I'll publish it as a git repository on Github Pages. If this happens, I will post a link to the repository here.