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.

Sign up for GitHub

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

Merge 1.14.x up into 2.0.x #505

Merged
merged 2 commits into from
Oct 1, 2024
Merged

Merge 1.14.x up into 2.0.x #505

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
cc57ede
Use a valid heading structure
greg0ire Oct 1, 2024
7f93627
Merge pull request #504 from greg0ire/fix-headings
SenseException Oct 1, 2024
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
15 changes: 9 additions & 6 deletions docs/en/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,8 @@
Getting Started
===============

Deprecation notice
==================
------------------

PHP 8 introduced `attributes
<https://www.php.net/manual/en/language.attributes.overview.php>`_,
Expand All @@ -15,7 +18,7 @@ Have a look at `our blog <https://www.doctrine-project.org/2022/11/04/annotation
to learn more.

Introduction
============
------------

Doctrine Annotations allows to implement custom annotation
functionality for PHP classes and functions.
Expand All @@ -39,7 +42,7 @@ class mapping, but it can be used in other projects for other purposes
too.

Installation
============
------------

You can install the Annotation component with composer:

Expand All @@ -48,7 +51,7 @@ You can install the Annotation component with composer:
$ composer require doctrine/annotations

Create an annotation class
==========================
--------------------------

An annotation class is a representation of the later used annotation
configuration in classes. The annotation class of the previous example
Expand All @@ -69,7 +72,7 @@ The annotation class is declared as an annotation by ``@Annotation``.
:doc:`Read more about custom annotations. <custom>`

Reading annotations
===================
-------------------

The access to the annotations happens by reflection of the class or function
containing them. There are multiple reader-classes implementing the
Expand Down Expand Up @@ -106,7 +109,7 @@ function.
:doc:`Read more about handling annotations. <annotations>`

IDE Support
-----------
^^^^^^^^^^^

Some IDEs already provide support for annotations:

Expand Down
Loading