From 143806b7875e2c1c226f173f168f585c1f131c64 Mon Sep 17 00:00:00 2001 From: DerStoffel Date: Thu, 21 Jan 2016 22:13:38 +0100 Subject: [PATCH 1/4] added Annotation to glossary --- glossary.rst | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/glossary.rst b/glossary.rst index 53da796cfb2..11ab28214e0 100644 --- a/glossary.rst +++ b/glossary.rst @@ -125,6 +125,11 @@ Glossary Symfony's configuration files. See the :doc:`/components/yaml/introduction` chapter. + Annotation + Annotations are notes written above your code. They can either be explanatory and will be + ignored during execution or add functionality to the line of code directly below as a means of + configuration. For example, the annotation @var describes the type of a variable, whereas for example in + Symfony2 @Assert can add validation to a member variable of a class (see :doc:`/book/validation` chapter). .. _`service-oriented architecture`: https://wikipedia.org/wiki/Service-oriented_architecture .. _`HTTP Wikipedia`: https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol From 8d6c0e3219a5d5a95a0d75f203795b78f969953b Mon Sep 17 00:00:00 2001 From: DerStoffel Date: Thu, 21 Jan 2016 22:16:18 +0100 Subject: [PATCH 2/4] reformatted annotation text --- glossary.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/glossary.rst b/glossary.rst index 11ab28214e0..26d58b36eac 100644 --- a/glossary.rst +++ b/glossary.rst @@ -128,8 +128,8 @@ Glossary Annotation Annotations are notes written above your code. They can either be explanatory and will be ignored during execution or add functionality to the line of code directly below as a means of - configuration. For example, the annotation @var describes the type of a variable, whereas for example in - Symfony2 @Assert can add validation to a member variable of a class (see :doc:`/book/validation` chapter). + configuration. For example, the annotation ``@var`` describes the type of a variable, whereas for example in + Symfony2 ``@Assert`` can add validation to a member variable of a class (see :doc:`/book/validation` chapter). .. _`service-oriented architecture`: https://wikipedia.org/wiki/Service-oriented_architecture .. _`HTTP Wikipedia`: https://en.wikipedia.org/wiki/Hypertext_Transfer_Protocol From d89abe0cb98b6cb492de5b46472774d4702044bc Mon Sep 17 00:00:00 2001 From: DerStoffel Date: Thu, 21 Jan 2016 22:22:28 +0100 Subject: [PATCH 3/4] corrected wording --- glossary.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/glossary.rst b/glossary.rst index 26d58b36eac..3b574104c6c 100644 --- a/glossary.rst +++ b/glossary.rst @@ -128,7 +128,7 @@ Glossary Annotation Annotations are notes written above your code. They can either be explanatory and will be ignored during execution or add functionality to the line of code directly below as a means of - configuration. For example, the annotation ``@var`` describes the type of a variable, whereas for example in + configuration. For example, the annotation ``@var`` describes the type of a variable, whereas in Symfony2 ``@Assert`` can add validation to a member variable of a class (see :doc:`/book/validation` chapter). .. _`service-oriented architecture`: https://wikipedia.org/wiki/Service-oriented_architecture From 02157d71e29848228276db0fab1fb911dae62a86 Mon Sep 17 00:00:00 2001 From: DerStoffel Date: Fri, 22 Jan 2016 10:06:05 +0100 Subject: [PATCH 4/4] updated definition of annotations --- glossary.rst | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/glossary.rst b/glossary.rst index 3b574104c6c..ab895bf2731 100644 --- a/glossary.rst +++ b/glossary.rst @@ -126,7 +126,7 @@ Glossary chapter. Annotation - Annotations are notes written above your code. They can either be explanatory and will be + Annotations are metadata written alongside your code. They can either be explanatory and will be ignored during execution or add functionality to the line of code directly below as a means of configuration. For example, the annotation ``@var`` describes the type of a variable, whereas in Symfony2 ``@Assert`` can add validation to a member variable of a class (see :doc:`/book/validation` chapter).