Jingga/Developer-Guide
1
0
Fork 0
mirror of https://github.com/Karaka-Management/Developer-Guide.git synced 2026-02-04 15:08:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update documentation.md

Browse Source
This commit is contained in:
Dennis Eichhorn 2018-07-31 11:01:32 +02:00 committed by GitHub
parent 1f8dd85173
commit 74b6bd0ec1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 4 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
standards/documentation.md
View File

@ -128,8 +128,8 @@ A function/method documentation MUST be implemented in the following form:
* *
* Optional example or more detailed description. * Optional example or more detailed description.
* *
* @param {variable_type} param1Name Parameter description * @param {variable_type_1} param1Name Parameter description
* @param {variable_type} [optionalPara] Parameter description * @param {variable_type} [optionalPara] Parameter description
* *
* @return {return_type} * @return {return_type}
* *
@ -137,4 +137,6 @@ A function/method documentation MUST be implemented in the following form:
*/ */
``` ```
Please also note the correct alignment of `@param` type, name and description
### Variable ### Variable