Jingga/Developer-Guide
1
0
Fork 0
mirror of https://github.com/Karaka-Management/Developer-Guide.git synced 2026-01-11 20:38:42 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Fixing to rfc lingo

Browse Source
This commit is contained in:
Dennis Eichhorn 2016-07-08 15:06:22 +02:00
parent 3b83d5b283
commit 046f7bcd74
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
standards/documentation.md
View File

@ -6,7 +6,7 @@ The php documentation is based on PhpDocumentor, therefore only valid PhpDocumen
### File
A file documentation is mandatory and needs to have the following layout:
A file documentation MUST be implemented in the following form:
```
/**
@ -27,7 +27,7 @@ A file documentation is mandatory and needs to have the following layout:
### Class
A class documentation is mandatory and needs to have the following layout:
A class documentation MUST be implemented in the following form:
```
/**
@ -45,7 +45,7 @@ A class documentation is mandatory and needs to have the following layout:
#### Member
A member variable documentation is mandatory and needs to have the following layout:
A member variable documentation MUST be implemented in the following form:
```
/**
@ -58,7 +58,7 @@ A member variable documentation is mandatory and needs to have the following lay
#### Function/Method
A function/method documentation is mandatory and needs to have the following layout:
A function/method documentation MUST be implemented in the following form:
```
/**