Skip to content

Commit dd63cf7

Browse files
committed
Fix docs
1 parent 535aaaa commit dd63cf7

File tree

3 files changed

+6
-1
lines changed

3 files changed

+6
-1
lines changed

src/csfml_audio.nim

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ include csfml_audio_gen
3737

3838

3939
proc newSound*(buffer: SoundBuffer): Sound =
40-
## *Returns:* A new Sound with this buffer
40+
## *Returns*: A new Sound with this buffer
4141
result = newSound()
4242
if result == nil: return nil
4343
result.buffer = buffer

src/csfml_graphics.nim

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,7 @@ proc color*(red, green, blue: int, alpha: int = 255): Color =
4646
## - ``green``: Green component (in the range [0, 255])
4747
## - ``blue``: Blue component (in the range [0, 255])
4848
## - ``alpha``: Alpha (opacity) component (in the range [0, 255])
49+
##
4950
## *Returns*: Color from its 4 RGBA components
5051
result.r = uint8 red
5152
result.g = uint8 green
@@ -178,6 +179,7 @@ proc matrixGL*(transform: Transform): array[0..15, cfloat] =
178179
##
179180
## *Arguments*:
180181
## - ``transform``: Transform object
182+
##
181183
## *Returns*: 16-element array
182184
transform.getMatrix(addr(result[0]))
183185

src/csfml_window.nim

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,7 @@ proc contextSettings*(depth: cint = 0, stencil: cint = 0, antialiasing: cint = 0
4949
## ``antialiasing``: Antialiasing level
5050
## ``major``: Major number of the context version
5151
## ``minor``: Minor number of the context version
52+
##
5253
## *Returns*: ContextSettings with these members
5354
result.depthBits = depth
5455
result.stencilBits = stencil
@@ -74,6 +75,7 @@ proc videoMode*(modeWidth, modeHeight: cint, bitsPerPixel: cint = 32): VideoMode
7475
## - ``modeWidth``: Width in pixels
7576
## - ``modeHeight``: Height in pixels
7677
## - ``modeBitsPerPixel``: Pixel depths in bits per pixel
78+
##
7779
## *Returns*: a VideoMode with these members
7880
result.width = modeWidth
7981
result.height = modeHeight
@@ -132,6 +134,7 @@ proc newWindow*(mode: VideoMode, title: string, style: BitMaskU32 = WindowStyle.
132134
## - ``title``: Title of the window (normal UTF-8 string)
133135
## - ``style``: Window style
134136
## - ``settings``: Additional settings for the underlying OpenGL context
137+
##
135138
## *Returns:* A new Window object
136139
var t = utf8to32(title)
137140
newWindow_U32(mode, addr(t[0]), style, settings)

0 commit comments

Comments
 (0)