DRAFT |
Style Guide: Code Examples
All API pages in this wiki contain a section for code examples. This guide provides instructions for adding your own content to the Code Examples section of these pages.
Contents
General Guidelines
The Code Examples section should provide simple examples of real-world applications of the API.
Please post code examples showing how you have used the API that may benefit other users.
- Do not post anything that you do not have permission to post publicly.
- Code examples should have adequate comments to make them clear and useful.
- Please remember to keep it simple and easy to understand.
For assistance with editing, saving, or wiki-appropriate markup see the Wiki Basics Style Guide.
Adding Your Code Examples
Place your code example in the == Code Examples == section:
If... |
Then... |
your code example is the first on the page |
replace the following with your code |
Note: Do not change or remove any of the markup immediately above or below that line |
|
there are existing code examples on the page |
add a new code box with your code to the end of the Code Examples section, |
Markup: Insert the following into the spot where your example will be located and place your content on the blank line between the markup: |
|
<<MiniPage(`{{{#!highlight cpp`<<BR>><<BR>>`}}}`)>> |
|
Example: SDL_Init() |
For more information on markup see http://wiki.libsdl.org/moin.cgi/SGWikiBasics
Resources
Our goal is to create accurate, consistent, helpful, user-friendly documentation. We appreciate your efforts to make your additions fit into the existing framework and retain the same look and feel as much as possible.
If you have questions that aren't addressed here:
- Search for another page that contains something similar to what you want to do and copy all the basics as much as applicable.
Check the other SDL Style Guides.
Post a question to Feedback and include a way to contact you.
Post a question to the Mailing List
Send a comment or question to <ANTI SPAM wiki AT libsdl DOT org> for clarification.
If you have suggestions for changes or additions to this document or any other portion of the wiki please don't hesitate to contact us with your thoughts. We are happy to have the participation!
Disclaimer
All content modifications are subject to review for consistency and quality. We reserve the right to remove or modify any content added to this wiki at any time. You may direct questions or concerns to <ANTI SPAM wiki AT libsdl DOT org>.
