Difference between revisions of "Template:FunctionPage"
Jump to navigation
Jump to search
imported>StDoodle m |
imported>StDoodle m |
||
Line 1: | Line 1: | ||
− | <noinclude>This is template for a function page (for just a function line, see "Template:Function"). | + | <noinclude><p>This is template for a function page (for just a function line, see "Template:Function").</p> |
+ | <p>The following is the full function call with all possible parameters. Please note that you would rarely, if ever, require everything shown.</p> | ||
<pre> | <pre> | ||
{{FunctionPage | | {{FunctionPage | | ||
− | page_name= | + | page_name=FUNCTION_NAME | |
function1_return_type=DATATYPE | | function1_return_type=DATATYPE | | ||
function1_returns_also=SECONDARY_DATAYPE_OR_DELETE | | function1_returns_also=SECONDARY_DATAYPE_OR_DELETE | | ||
Line 70: | Line 71: | ||
<syntaxhighlight lang="c"> | <syntaxhighlight lang="c"> | ||
CODE GOES HERE | CODE GOES HERE | ||
− | </syntaxhighlight>}} | + | </syntaxhighlight>}} | |
+ | code2={{CodeSample | | ||
+ | title=CODE EXAMPLE TITLE | | ||
+ | description=DESCRIPTION OF CODE | | ||
+ | code= | ||
+ | <syntaxhighlight lang="c"> | ||
+ | CODE GOES HERE | ||
+ | </syntaxhighlight>}} | | ||
+ | code3={{CodeSample | | ||
+ | title=CODE EXAMPLE TITLE | | ||
+ | description=DESCRIPTION OF CODE | | ||
+ | code= | ||
+ | <syntaxhighlight lang="c"> | ||
+ | CODE GOES HERE | ||
+ | </syntaxhighlight>}} | | ||
+ | code4={{CodeSample | | ||
+ | title=CODE EXAMPLE TITLE | | ||
+ | description=DESCRIPTION OF CODE | | ||
+ | code= | ||
+ | <syntaxhighlight lang="c"> | ||
+ | CODE GOES HERE | ||
+ | </syntaxhighlight>}} | | ||
+ | code5={{CodeSample | | ||
+ | title=CODE EXAMPLE TITLE | | ||
+ | description=DESCRIPTION OF CODE | | ||
+ | code= | ||
+ | <syntaxhighlight lang="c"> | ||
+ | CODE GOES HERE | ||
+ | </syntaxhighlight>}} | | ||
+ | see_also={{SeeAlso|FIRST|SECOND|ETC}} | | ||
+ | cli_equiv=LIST CLI EQUIVALENT | | ||
+ | special=SPECIAL NOTES SUCH AS NOT-LOGGED-IN VALUE | ||
}} | }} | ||
</pre> | </pre> | ||
+ | <p>Replace everything in CAPS with appropriate information for the given page.</p> | ||
[[Category:Basic Templates]] | [[Category:Basic Templates]] | ||
</noinclude> | </noinclude> |
Revision as of 12:33, 25 February 2010
This is template for a function page (for just a function line, see "Template:Function").
The following is the full function call with all possible parameters. Please note that you would rarely, if ever, require everything shown.
{{FunctionPage | page_name=FUNCTION_NAME | function1_return_type=DATATYPE | function1_returns_also=SECONDARY_DATAYPE_OR_DELETE | function1_parameter1={{Param|TYPE|SHORTDESC}} | function1_parameter1_desc= DESCRIPTION_OF_PARAM | function1_parameter2={{Param|TYPE|SHORTDESC}} | function1_parameter2_desc= DESCRIPTION_OF_PARAM | function1_parameter3={{Param|TYPE|SHORTDESC}} | function1_parameter3_desc= DESCRIPTION_OF_PARAM | function1_parameter4={{Param|TYPE|SHORTDESC}} | function1_parameter4_desc= DESCRIPTION_OF_PARAM | function1_parameter5={{Param|TYPE|SHORTDESC}} | function1_parameter5_desc= DESCRIPTION_OF_PARAM | function2_return_type=DATATYPE | function2_returns_also=SECONDARY_DATAYPE_OR_DELETE | function2_parameter1={{Param|TYPE|SHORTDESC}} | function2_parameter1_desc= DESCRIPTION_OF_PARAM | function2_parameter2={{Param|TYPE|SHORTDESC}} | function2_parameter2_desc= DESCRIPTION_OF_PARAM | function2_parameter3={{Param|TYPE|SHORTDESC}} | function2_parameter3_desc= DESCRIPTION_OF_PARAM | function2_parameter4={{Param|TYPE|SHORTDESC}} | function2_parameter4_desc= DESCRIPTION_OF_PARAM | function2_parameter5={{Param|TYPE|SHORTDESC}} | function2_parameter5_desc= DESCRIPTION_OF_PARAM | function3_return_type=DATATYPE | function3_returns_also=SECONDARY_DATAYPE_OR_DELETE | function3_parameter1={{Param|TYPE|SHORTDESC}} | function3_parameter1_desc= DESCRIPTION_OF_PARAM | function3_parameter2={{Param|TYPE|SHORTDESC}} | function3_parameter2_desc= DESCRIPTION_OF_PARAM | function3_parameter3={{Param|TYPE|SHORTDESC}} | function3_parameter3_desc= DESCRIPTION_OF_PARAM | function3_parameter4={{Param|TYPE|SHORTDESC}} | function3_parameter4_desc= DESCRIPTION_OF_PARAM | function3_parameter5={{Param|TYPE|SHORTDESC}} | function3_parameter5_desc= DESCRIPTION_OF_PARAM | function4_return_type=DATATYPE | function4_returns_also=SECONDARY_DATAYPE_OR_DELETE | function4_parameter1={{Param|TYPE|SHORTDESC}} | function4_parameter1_desc= DESCRIPTION_OF_PARAM | function4_parameter2={{Param|TYPE|SHORTDESC}} | function4_parameter2_desc= DESCRIPTION_OF_PARAM | function4_parameter3={{Param|TYPE|SHORTDESC}} | function4_parameter3_desc= DESCRIPTION_OF_PARAM | function4_parameter4={{Param|TYPE|SHORTDESC}} | function4_parameter4_desc= DESCRIPTION_OF_PARAM | function4_parameter5={{Param|TYPE|SHORTDESC}} | function4_parameter5_desc= DESCRIPTION_OF_PARAM | function5_return_type=DATATYPE | function5_returns_also=SECONDARY_DATAYPE_OR_DELETE | function5_parameter1={{Param|TYPE|SHORTDESC}} | function5_parameter1_desc= DESCRIPTION_OF_PARAM | function5_parameter2={{Param|TYPE|SHORTDESC}} | function5_parameter2_desc= DESCRIPTION_OF_PARAM | function5_parameter3={{Param|TYPE|SHORTDESC}} | function5_parameter3_desc= DESCRIPTION_OF_PARAM | function5_parameter4={{Param|TYPE|SHORTDESC}} | function5_parameter4_desc= DESCRIPTION_OF_PARAM | function5_parameter5={{Param|TYPE|SHORTDESC}} | function5_parameter5_desc= DESCRIPTION_OF_PARAM | function_description=DESCRIPTION_OF_FUNCTION | code1={{CodeSample | title=CODE EXAMPLE TITLE | description=DESCRIPTION OF CODE | code= <syntaxhighlight lang="c"> CODE GOES HERE </syntaxhighlight>}} | code2={{CodeSample | title=CODE EXAMPLE TITLE | description=DESCRIPTION OF CODE | code= <syntaxhighlight lang="c"> CODE GOES HERE </syntaxhighlight>}} | code3={{CodeSample | title=CODE EXAMPLE TITLE | description=DESCRIPTION OF CODE | code= <syntaxhighlight lang="c"> CODE GOES HERE </syntaxhighlight>}} | code4={{CodeSample | title=CODE EXAMPLE TITLE | description=DESCRIPTION OF CODE | code= <syntaxhighlight lang="c"> CODE GOES HERE </syntaxhighlight>}} | code5={{CodeSample | title=CODE EXAMPLE TITLE | description=DESCRIPTION OF CODE | code= <syntaxhighlight lang="c"> CODE GOES HERE </syntaxhighlight>}} | see_also={{SeeAlso|FIRST|SECOND|ETC}} | cli_equiv=LIST CLI EQUIVALENT | special=SPECIAL NOTES SUCH AS NOT-LOGGED-IN VALUE }}
Replace everything in CAPS with appropriate information for the given page.