Help:Adding General Function Reference

Naming

The actual type of the reference page (is it VectorScript or VCOM) is determined by the category in which the page exist.

The category is represented in the name before the semi-colon in the name.

For example "VCOM:Something" is a page "Something" in category "VCOM".

IMPORTANT Be careful when naming pages. The name is very important!

See Help:Contents#Page Name

General Function Page

Here is information of how to format general function reference page.

More information on the pages and the tags here Help:Adding Reference.

Here is template for general function reference pages:

__TOC__
<vwDoc>

-----------------------------------------------------------------------------------------------------------
<desc>
... some description ...
</desc>

-----------------------------------------------------------------------------------------------------------
<def>
<funcDef lang="cpp">
... function definition ...
</funcDef>
</def>

-----------------------------------------------------------------------------------------------------------
<params>
<lineList ident=1>
<line>
...parameter type...
...parameter name...
...parameter information...
</line>
</lineList>
</params>

-----------------------------------------------------------------------------------------------------------
<return>
</return>

-----------------------------------------------------------------------------------------------------------
<remarks>
</remarks>

-----------------------------------------------------------------------------------------------------------
<sample>
</sample>

-----------------------------------------------------------------------------------------------------------
<version>
</version>

-----------------------------------------------------------------------------------------------------------
<seeAlso>
</seeAlso>

</vwDoc>

[[Category:...VS or VCOM...:...|...]]

See Also

• Help:Contents -- general help on Wiki editing.
• Help:Adding Article -- how to add general article page.
• Help:Adding Function Reference -- general information on adding reference page.
• Help:Adding General Function Reference -- how to add general function reference page.
• Help:Adding VCOM Function Reference -- how to add VCOM function reference page.
• Help:Adding VectorScript Function Reference -- how to add VectorScript function reference page.