Fix typo in the name and add index file

goaop · Feb 15, 2016 · 8c98194 · 8c98194
1 parent a34f6df
commit 8c98194
Show file tree

Hide file tree

Showing 9 changed files with 22 additions and 0 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -0,0 +1,22 @@
+ParserReflection API Reference
+==============
+
+Introduction
+--------
+PHP comes with a complete reflection API that adds the ability to reverse-engineer classes, interfaces, functions, methods and extensions. Additionally, the reflection API offers ways to retrieve doc comments for functions, classes and methods.
+
+But this reflection API requires concrete element to be loaded into the memory. Once element is loaded, it can not be changed, modified or updated without special extensions. 
+
+`goaop\parser-reflection` packet is a userland implementation of reflection API that is fully compatible with internal one, but doesn't require element (e.g. class or function) to be loaded into the PHP. Only the source code is required for performing the raw analysis.
+
+Reference
+---------
+
+- [`ReflectionClass`](reflection_class.md)
+- [`ReflectionFile`](reflection_file.md)
+- [`ReflectionFileNamespace`](reflection_file_namespace.md)
+- [`ReflectionFunction`](reflection_function.md)
+- [`ReflectionMethod`](reflection_method.md)
+- [`ReflectionParameter`](reflection_parameter.md)
+- [`ReflectionProperty`](reflection_property.md)
+- [`ReflectionType`](reflection_type.md)
diff --git a/docs/relection_class.md → docs/reflection_class.md b/docs/relection_class.md → docs/reflection_class.md
diff --git a/docs/relection_file.md → docs/reflection_file.md b/docs/relection_file.md → docs/reflection_file.md
diff --git a/docs/relection_file_namespace.md → docs/reflection_file_namespace.md b/docs/relection_file_namespace.md → docs/reflection_file_namespace.md
diff --git a/docs/relection_function.md → docs/reflection_function.md b/docs/relection_function.md → docs/reflection_function.md
diff --git a/docs/relection_method.md → docs/reflection_method.md b/docs/relection_method.md → docs/reflection_method.md
diff --git a/docs/relection_parameter.md → docs/reflection_parameter.md b/docs/relection_parameter.md → docs/reflection_parameter.md
diff --git a/docs/relection_property.md → docs/reflection_property.md b/docs/relection_property.md → docs/reflection_property.md
diff --git a/docs/relection_type.md → docs/reflection_type.md b/docs/relection_type.md → docs/reflection_type.md