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.

Getting Started

If a page can be edited you will see two options in the left column to choose from:

1. Edit (Text)
   • Use the Text editor to see the existing markup. You will need to use the Preview feature to view the content as it will appear. The Text editor provides more power/flexibility for editing but requires that you know the wiki markup.
2. Edit (GUI)
   • Use the GUI editor to see the content appear roughly as it would on the screen as you edit. The GUI editor provides buttons and shortcuts, much like a simple word processor, to add formatting markup such as bolding text. It is simpler to use but does not provide all the options that the Text editor does.

3. Suggestions: If you are familiar with the wiki markup or are simply pasting your content in you will likely find the Text editor more to your liking.
   If you are not familiar with the wiki markup or are adding content that will require formatting you will likely find the GUI editor more to your liking.
   You can find more information about wiki markup at wiki help documentation.

The Basics

The Specifics

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
     
    }}}

Adding Remarks

Ready To Save

When you have completed your additions you will find Save Changes and Preview options in the left column.

• Preview will provide a draft view of the page as it will appear on the screen but it does not save your changes. If you are happy with the result in the Preview you will still need to Save Changes.
• When you save your changes please include a comment that summarizes what you have done.