mirror of
https://github.com/Karaka-Management/Developer-Guide.git
synced 2026-01-26 02:48:41 +00:00
Fixing to rfc lingo
This commit is contained in:
parent
3b83d5b283
commit
046f7bcd74
|
|
@ -6,7 +6,7 @@ The php documentation is based on PhpDocumentor, therefore only valid PhpDocumen
|
||||||
|
|
||||||
### File
|
### 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
|
### 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
|
#### 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
|
#### 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:
|
||||||
|
|
||||||
```
|
```
|
||||||
/**
|
/**
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue
Block a user