Skip to content

Commit e10469f

Browse files
committed
Upgrade documentation, issue los-cocos#267
switch to the google style docstrings, using the Sphinx extension Napoleon. Fix auto-doc warnings. Some code was commented out using docstrings instead of comments. This created problems when parsing docstrings.
1 parent cbe07bc commit e10469f

File tree

7 files changed

+437
-257
lines changed

7 files changed

+437
-257
lines changed

cocos/audio/SDL/rwops.py

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -94,8 +94,8 @@ class SDL_RWops(Structure):
9494
'''Create an SDL_RWops structure from a contiguous region of memory.
9595
9696
:Parameters:
97-
- `mem`: ``c_void_p``
98-
- `size`: int
97+
`mem`: ``c_void_p``
98+
`size`: int
9999
100100
:rtype: `SDL_RWops`
101101
:since: 1.2.7
@@ -107,27 +107,27 @@ class SDL_RWops(Structure):
107107
require_return=True,
108108
since=(1, 2, 7))
109109

110-
""" These functions shouldn't be useful to Pythoners.
111-
SDL_AllocRW = dll.function('SDL_AllocRW',
112-
'''Allocate a blank SDL_Rwops structure.
113-
114-
:rtype: `SDL_RWops`
115-
'''
116-
args=[],
117-
arg_types=[],
118-
return_type=POINTER(SDL_RWops),
119-
dereference_return=True,
120-
require_return=True)
121-
122-
SDL_FreeRW = dll.function('SDL_FreeRW',
123-
'''Free a SDL_RWops structure.
124-
125-
:param area: `SDL_RWops`
126-
'''
127-
args=['area'],
128-
arg_types=[POINTER(SDL_RWops)],
129-
return_type=None)
130-
"""
110+
# These functions shouldn't be useful to Pythoners.
111+
# SDL_AllocRW = dll.function('SDL_AllocRW',
112+
# '''Allocate a blank SDL_Rwops structure.
113+
114+
# :rtype: `SDL_RWops`
115+
# '''
116+
# args=[],
117+
# arg_types=[],
118+
# return_type=POINTER(SDL_RWops),
119+
# dereference_return=True,
120+
# require_return=True)
121+
122+
# SDL_FreeRW = dll.function('SDL_FreeRW',
123+
# '''Free a SDL_RWops structure.
124+
125+
# :param area: `SDL_RWops`
126+
# '''
127+
# args=['area'],
128+
# arg_types=[POINTER(SDL_RWops)],
129+
# return_type=None)
130+
131131

132132

133133
# XXX Tested read from open() only so far

0 commit comments

Comments
 (0)