Use attributes instead of annotations in the docs

EasyCorp · Oct 13, 2024 · b3d9ac3 · b3d9ac3
1 parent c50e2bf
commit b3d9ac3
Show file tree

Hide file tree

Showing 3 changed files with 10 additions and 19 deletions.
diff --git a/doc/actions.rst b/doc/actions.rst
@@ -487,33 +487,27 @@ Symfony controller called ``BusinessStatsController``::
     namespace App\Controller\Admin;
 
     use App\Stats\BusinessStatsCalculator;
-    use Sensio\Bundle\FrameworkExtraBundle\Configuration\Security;
     use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
-    use Symfony\Component\Routing\Annotation\Route;
+    use Symfony\Component\Routing\Attribute\Route;
+    use Symfony\Component\Security\Http\Attribute\IsGranted;
 
-    /**
-     * @Security("is_granted('ROLE_ADMIN')")
-     */
+    #[IsGranted('ROLE_ADMIN')]
     class BusinessStatsController extends AbstractController
     {
         public function __construct(BusinessStatsCalculator $businessStatsCalculator)
         {
             $this->businessStatsCalculator = $businessStatsCalculator;
         }
 
-        /**
-         * @Route("/admin/business-stats", name="admin_business_stats")
-         */
+        #[Route("/admin/business-stats", name="admin_business_stats")]
         public function index()
         {
             return $this->render('admin/business_stats/index.html.twig', [
                 'data' => $this->businessStatsCalculator->getStatsSummary(),
             ]);
         }
 
-        /**
-         * @Route("/admin/business-stats/{id}", name="admin_business_stats_customer")
-         */
+        #[Route("/admin/business-stats/{id}", name="admin_business_stats_customer")]
         public function customer(Customer $customer)
         {
             return $this->render('admin/business_stats/customer.html.twig', [
@@ -630,7 +624,6 @@ by EasyAdmin::
 
     use EasyCorp\Bundle\EasyAdminBundle\Router\AdminUrlGenerator;
     use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
-    use Symfony\Component\Routing\Annotation\Route;
 
     class SomeController extends AbstractController
     {

diff --git a/doc/dashboards.rst b/doc/dashboards.rst
@@ -89,7 +89,7 @@ dashboard with the ``make:admin:dashboard`` command, the route is defined using
         use EasyCorp\Bundle\EasyAdminBundle\Config\Dashboard;
         use EasyCorp\Bundle\EasyAdminBundle\Controller\AbstractDashboardController;
         use Symfony\Component\HttpFoundation\Response;
-        use Symfony\Component\Routing\Annotation\Route;
+        use Symfony\Component\Routing\Attribute\Route;
 
         class DashboardController extends AbstractDashboardController
         {
@@ -155,7 +155,7 @@ application, you can define an explicit route name to simplify your code:
         use EasyCorp\Bundle\EasyAdminBundle\Config\Dashboard;
         use EasyCorp\Bundle\EasyAdminBundle\Controller\AbstractDashboardController;
         use Symfony\Component\HttpFoundation\Response;
-        use Symfony\Component\Routing\Annotation\Route;
+        use Symfony\Component\Routing\Attribute\Route;
 
         class DashboardController extends AbstractDashboardController
         {
@@ -893,14 +893,12 @@ applications can rely on its default values:
 
     use Symfony\Bundle\FrameworkBundle\Controller\AbstractController;
     use Symfony\Component\HttpFoundation\Response;
-    use Symfony\Component\Routing\Annotation\Route;
+    use Symfony\Component\Routing\Attribute\Route;
     use Symfony\Component\Security\Http\Authentication\AuthenticationUtils;
 
     class SecurityController extends AbstractController
     {
-        /**
-         * @Route("/login", name="login")
-         */
+        #[Route("/login", name="login")]
         public function login(AuthenticationUtils $authenticationUtils): Response
         {
             $error = $authenticationUtils->getLastAuthenticationError();

diff --git a/doc/fields.rst b/doc/fields.rst
@@ -115,7 +115,7 @@ To do so, add the following method to the entity::
 
     use Doctrine\ORM\Mapping as ORM;
 
-    /** @ORM\Entity */
+    #[ORM\Entity]
     class Customer
     {
         // ...