blob: 49860589f8fad001397468afcffee197999c5a9b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
|
#if $function.short_description is not None
#set $title = $function.name + ' - ' + $function.short_description
#else
#set $title = $function.name
#end if
$title
#echo ''.join(['=']*len($title)) #
..
.. c:function:: $signature
..
:param:
#for $param in $function.parameters:
#if $param.name is ''
#continue
#end if
#if $param.direction is not None
#set name_description = '**[%s]** **%s**' % ($param.direction, $param.name)
#else
#set name_description = '**%s**' % $param.name
#end if
#if $param.description is not None
#set $description= ' - ' + $param.description
#else
#set $description=''
#end if
$name_description$description
#end for
..
#if len($function.retval_description) > 0
:retval:
#for $retval in $function.retval_description:
- $retval
#end for
#end if
#if len($function.return_description) > 0
:return:
#for $retval in $function.return_description:
- $retval
#end for
#end if
..
#if $function.deprecated_description is not None
$function.deprecated_description
#end if
#if $function.long_description is not None
$function.long_description
#end if
..
#if $function.sa_description is not None
.. seealso::
$function.sa_description
#end if
#if $function.warn_description is not None or $function.notes_description is not None
#if $function.warn_description is not None
.. warning::
$function.warn_description
#end if
#if $function.notes_description is not None
.. note::
$function.notes_description
#end if
#end if
#if $function.version_num is not None
.. note::
$function.version_num
#end if
|
