|
Size: 858
Comment: correct comma in RV
|
Size: 2257
Comment: added commented instructions for creating a new page from this template
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 6: | Line 6: |
| = SDL_FunctionName = Use this function to ''insert short function description here''. |
##You will need to remove the line #acl All:read above in order to be able to save the new page. Do not remove any other content above this comment. You may delete this comment before you save. ##*^*^*^*^*See http://wiki.libsdl.org/moin.cgi/SGFunctions for details on editing this page*^*^*^*^* = SDL_Function = Use this function to ******. ##Replace SDL_Function with the name of the function and ****** with a short description of the function according to the Style Guide, then delete this comment. |
| Line 10: | Line 18: |
| Line 16: | Line 25: |
| ##Fill in the above syntax per the Style Guide, then delete this comment. |
|
| Line 19: | Line 31: |
| ##Fill in the above table per the Style Guide, then delete this comment. |
|
| Line 20: | Line 35: |
| ''Remove this section if there is no return value. Many SDL functions use this standard text (remove if not applicable):'' Returns 0 on success or a negative error code on failure; call [[SDL_GetError]]() for more information. |
Returns ......; call [[SDL_GetError]]() for more information. ##For many functions (esp for int return values) replace the ...... above with 0 on success or a negative error code on failure , then delete these comments. --OR-- ##Replace ...... above with another appropriate description per the Style Guide, then delete these comments. --OR-- ##Remove this section if there is no return value, then delete these comments. |
| Line 29: | Line 47: |
| ##Leave this section as-is unless you have a code example to put in. In that case, replace You can add your code example here with your code example following the Style Guide instructions. Leave the rest of the markup alone and delete this comment. |
|
| Line 32: | Line 53: |
| ##Leave this section as-is unless you have a remark to put in. In that case, replace ''You can add useful comments here'' with your remark(s) following the Style Guide instructions. Leave the rest of the markup alone and delete this comment. |
|
| Line 34: | Line 58: |
| ##Remove this section if empty | |
| Line 37: | Line 62: |
| ##See the Style Guide for instructions on editing the footer. |
DRAFT |
SDL_Function
Use this function to ******.
Contents
Syntax
value SDL_FunctionName(param)
Function Parameters
param |
description |
Return Value
Returns ......; call SDL_GetError() for more information.
Code Examples
You can add your code example here
Remarks
You can add useful comments here
