From 3db1a1a8a8092e4cef73158214728fba3f2db93d Mon Sep 17 00:00:00 2001 From: Dennis Eichhorn Date: Wed, 17 Feb 2016 21:46:53 +0100 Subject: [PATCH] New files and removing duplication --- documentation.md | 104 ++++++++++++++++++++++++ inspections,_tests_&_code_guidelines.md | 14 ---- styles_and_layout.md | 19 +++++ 3 files changed, 123 insertions(+), 14 deletions(-) create mode 100644 documentation.md delete mode 100644 inspections,_tests_&_code_guidelines.md create mode 100644 styles_and_layout.md diff --git a/documentation.md b/documentation.md new file mode 100644 index 0000000..031c42b --- /dev/null +++ b/documentation.md @@ -0,0 +1,104 @@ +# Documentation + +## Php + +The php documentation is based on PhpDocumentor, therefore only valid PhpDocumentor comments are valid for files, classes, functions/methods and (member) variables. + +### File + +A file documentation is mandatory and needs to have the following layout: + +``` +/** + * File description + * + * PHP Version 7.0 + * + * @category Category name + * @package Package name + * @author Your Author 1 + * @author Your Author 2 + * @copyright Orange Management + * @license OMS License 1.0 + * @version 1.0.0 + * @link http://your.url.com + */ +``` + +### Class + +A class documentation is mandatory and needs to have the following layout: + +``` +/** + * Class description. + * + * @category Category name + * @package Package name + * @author Your Author 1 + * @author Your Author 2 + * @license OMS License 1.0 + * @link http://your.url.com + * @since 1.0.0 + */ +``` + +#### Member + +A member variable documentation is mandatory and needs to have the following layout: + +``` +/** + * Member variable description. + * + * @var variable_type + * @since 1.0.0 + */ +``` + +#### Function/Method + +A function/method documentation is mandatory and needs to have the following layout: + +``` +/** + * Function/method description. + * + * Optional example or more detailed description. + * + * @param variable_type $param1Name Parameter description + * @param variable_type $param2Name Parameter description + * + * @return return_type + * + * @since 1.0.0 + * @author Your Author 2 + */ +``` + +### Variable + +Variable documentation is not mandatory and can be omitted. However it's recommended to use a variable documentation for objects and arrays of objects in templates for ide code completion. + +Example: + +``` +/** @var TestObject[] $myArray */ +``` + +## JavaScript + +## Scss + +The scss documentation is based on SassDoc, therefore only valid SassDoc comments are valid for all scss files. + +``` +//// +// Documentation +// +// Optional example or more detailed description. +// +// @since 1.0.0 +// @author Your Author 2 +//// +``` \ No newline at end of file diff --git a/inspections,_tests_&_code_guidelines.md b/inspections,_tests_&_code_guidelines.md deleted file mode 100644 index ae15030..0000000 --- a/inspections,_tests_&_code_guidelines.md +++ /dev/null @@ -1,14 +0,0 @@ -# Inspections, Tests & Code Guidelines - -Running inspections and tests ensures the quality of the provided code. It -also helps to ensure multiple programmers follow the same standard which -helps to work on other programmers code. - -## Unit tests - -### PHPUnit - -## Code style - -## External tools - diff --git a/styles_and_layout.md b/styles_and_layout.md new file mode 100644 index 0000000..b53c238 --- /dev/null +++ b/styles_and_layout.md @@ -0,0 +1,19 @@ +# Styles and Layout + +## Css + +This project only supports scss and css. All css files need to be provided with a scss file which will be processed for every build. The css file has to be minimized, optimized and compressed as `.gz`. This means there is at least one scss file (multiple if you are combining/importing multiple scss files and creating one output css file), one css file and one compressed `.gz` file. The file name has to be lower case and the same for every file and only the extension is different. + +## Icons + +This project uses font-awesome for its icons, the following example allows for stacked icons e.g. creating new/undread email notifications: + +``` + + 333 + +``` + +## Examples + +An example of all styles can be found in the tests called `StandardElements.htm`. \ No newline at end of file