mirror of
https://github.com/Karaka-Management/Developer-Guide.git
synced 2026-01-26 19:08:41 +00:00
New files and removing duplication
This commit is contained in:
parent
45f9746285
commit
3db1a1a8a8
104
documentation.md
Normal file
104
documentation.md
Normal file
|
|
@ -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 <your@email.com>
|
||||||
|
* @author Your Author 2 <your.second@email.com>
|
||||||
|
* @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 <your@email.com>
|
||||||
|
* @author Your Author 2 <your.second@email.com>
|
||||||
|
* @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 <your.second@email.com>
|
||||||
|
*/
|
||||||
|
```
|
||||||
|
|
||||||
|
### 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 <your.second@email.com>
|
||||||
|
////
|
||||||
|
```
|
||||||
|
|
@ -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
|
|
||||||
|
|
||||||
19
styles_and_layout.md
Normal file
19
styles_and_layout.md
Normal file
|
|
@ -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:
|
||||||
|
|
||||||
|
```
|
||||||
|
<i class="fa fa-lg infoIcon fa-envelope">
|
||||||
|
<span class="badge">333</span>
|
||||||
|
</i>
|
||||||
|
```
|
||||||
|
|
||||||
|
## Examples
|
||||||
|
|
||||||
|
An example of all styles can be found in the tests called `StandardElements.htm`.
|
||||||
Loading…
Reference in New Issue
Block a user