|
Size: 820
Comment: content added
|
Size: 1407
Comment: in progress
|
| Deletions are marked like this. | Additions are marked like this. |
| Line 7: | Line 7: |
| This guide will provide general information about the Function, Enumeration, and Structure pages in this wiki, as well as the instructions needed to add your own content to the Code Examples or Remarks sections. | This guide provides the instructions needed to add your own content to the Code Examples or Remarks sections, as well as general information about the Function, Enumeration, and Structure pages in this wiki. {X} Existing content, including markup, should not be modified or removed unless specifically noted. |
| Line 11: | Line 13: |
| <<TableOfContents()>> ---- {X} Existing content, including markup, should not be modified or removed unless specifically noted below. |
|
| Line 17: | Line 15: |
| ---- | <<TableOfContents()>> == Adding Code Examples == {OK} Please post code examples showing how you have used a function that may benefit other users. * Do not post anything that you do not have permission to post publicly. * If the Code Examples section is empty please replace<<BR>>{{{You can add your code example here}}}<<BR>>with your code. * If there are existing examples please add yours to the end, or to a related section if there are many examples. . ''Example'': [[SDL_Init]]() * All content should be added within this markup. {{{{ {{{#!highlight cpp }}} }}}} == Adding Remarks == |
DRAFT |
SDL API Contribution Style Guide
This guide provides the instructions needed to add your own content to the Code Examples or Remarks sections, as well as general information about the Function, Enumeration, and Structure pages in this wiki.
Existing content, including markup, should not be modified or removed unless specifically noted.
If you would like to contribute to or edit other sections, more detailed instructions can be found at APIDocumentationStyleGuide.
You must have permission to make major edits or create new pages.
Please email docs@libsdl.org to request permission.
Adding Code Examples
Please post code examples showing how you have used a function that may benefit other users.
- Do not post anything that you do not have permission to post publicly.
If the Code Examples section is empty please replace
You can add your code example here
with your code.- If there are existing examples please add yours to the end, or to a related section if there are many examples.
Example: SDL_Init()
- All content should be added within this markup.
{{{#!highlight cpp }}}
