Source

pygame / doc / api_template.xml

Full commit
<?xml version="1.0" encoding="utf-8" ?>
<!DOCTYPE module SYSTEM "api.dtd">

<!-- 
     Pygame2 C API template for generating the C code doc strings and 
     RST/HTML documentation.
-->

<module name="NAME">
  <alias>ALIAS</alias>
  <short>SHORT DESC (single line)</short>
  <desc>DESCRIPTION</desc>
  <example>EXAMPLE CODE</example>
  
  <func name="METHODNAME">
    <call>FUNC()</call>
    <desc>DESCRIPTION</desc>
    <example>EXAMPLE CODE</example>
  </func>
  
  <class name="CLASSNAME">
    <cosntructor>CLASS()</cosntructor>
    <desc>DESCRIPTION</desc>
    <example>EXAMPLE CODE</example>
    <attr name="NAME">
      <desc>DESCRIPTION</desc>
      <example>EXAMPLE CODE</example>
    </attr>
    <method name="METHODNAME">
      <call>METHOD()</call>
      <desc>DESCRIPTION</desc>
      <example>EXAMPLE CODE</example>
    </method>
    </class>
  </module>