← Back to branch summary

~ubuntu-branches/ubuntu/karmic/gnustep-base/karmic

« back to all changes in this revision

Viewing changes to Tools/AutoDocTemplate.gsdoc

  • Committer: Bazaar Package Importer
  • Author(s): Eric Heintzmann
  • Date: 2005-04-17 00:14:38 UTC
  • mfrom: (1.2.1 upstream) (2.1.2 hoary)
  • Revision ID: james.westby@ubuntu.com-20050417001438-enf0y07c9tku85z1
Tags: 1.10.3-1
New upstream release.

Show diffs side-by-side

added added

removed removed

Lines of Context:
Tools/AutoDocTemplate.gsdoc
1
 
<?xml version="1.0" encoding='ISO-8859-1'?>
2
 
<!DOCTYPE gsdoc PUBLIC "-//GNUstep//DTD gsdoc 0.6.6//EN" "[[infoDictionary.dtd-ref]]">
3
 
  <gsdoc 
4
 
          [[if mainInterface.interfaceTitle == Class]]
5
 
            base="[[mainInterface.className]]"
6
 
      [[else]]
7
 
          [[if mainInterface.interfaceTitle == Category]]
8
 
base="[[mainInterface.className]]+[[mainInterface.categoryName]]"
9
 
      [[else]]
10
 
          [[if mainInterface.interfaceTitle == Protocol]]
11
 
base="[[mainInterface.protocolName]]Protocol"
12
 
      [[else]]
13
 
base=""
14
 
          [[endif Protocol]]
15
 
          [[endif Category]]
16
 
          [[endif Class]]
17
 
prev="[[infoDictionary.prev]]"
18
 
next="[[infoDictionary.next]]"
19
 
up="[[infoDictionary.up]]"
20
 
stylesheeturl="[[infoDictionary.stylesheeturl]]">
21
 
        <head>
22
 
          <title>[[infoDictionary.basetitle]] [[mainTitle]]</title>
23
 
          <author name="[[infoDictionary.author-name]]">
24
 
                <email address="[[infoDictionary.author-email]]"/>
25
 
                  <url url="[[infoDictionary.author-url]]"/>
26
 
                        <desc>[[infoDictionary.author-desc]]</desc>
27
 
          </author>
28
 
          <version>[[version]]</version>
29
 
          <date>[[timestampString]]</date>
30
 
          <abstract>
31
 
          [[if mainInterface.interfaceTitle == Class]]
32
 
            [<uref url="[[mainInterface.className]].gsdoc">Source : [[mainInterface.className]].gsdoc</uref>]
33
 
      [[else]]
34
 
          [[if mainInterface.interfaceTitle == Category]]
35
 
[<uref url="[[mainInterface.className]]+[[mainInterface.categoryName]].gsdoc">Source : [[mainInterface.className]]+[[mainInterface.categoryName]].gsdoc</uref>]
36
 
      [[else]]
37
 
          [[if mainInterface.interfaceTitle == Protocol]]
38
 
[<uref url="[[mainInterface.protocolName]]Protocol.gsdoc">Source : [[mainInterface.protocolName]]Protocol.gsdoc</uref>]
39
 
          [[endif Protocol]]
40
 
          [[endif Category]]
41
 
          [[endif Class]]
42
 
 <uref url="[[infoDictionary.dtd-url]]">DTD</uref>] </abstract>
43
 
          <copy>[[copyrightYear]][[if copyrightOwner.length > 0]] by [[copyrightOwner]][[endif]]</copy>
44
 
        </head> 
45
 
        <body>
46
 
          <front>
47
 
                <contents/>               
48
 
          </front>
49
 
 
50
 
        
51
 
[[if hasMainInterface == 1]]
52
 
             <chapter id="#">
53
 
[[endif hasMainInterface == 1]]
54
 
 
55
 
[[if hasMainInterface == 1]]
56
 
          <heading>[[mainTitle]]</heading>
57
 
          [[if mainInterface.interfaceTitle == Class]]
58
 
            <class name="[[mainInterface.className]]" [[if mainInterface.inheritsString.length > 0]] super="[[mainInterface.inheritsString]]"[[endif]]>
59
 
      [[else]]
60
 
          [[if mainInterface.interfaceTitle == Category]]
61
 
          <category name="[[mainInterface.categoryName]]" class="[[mainInterface.className]]">
62
 
      [[else]]
63
 
          [[if mainInterface.interfaceTitle == Protocol]]
64
 
          <protocol name="[[mainInterface.protocolName]]">
65
 
          [[endif Protocol]]
66
 
          [[endif Category]]
67
 
          [[endif Class]]
68
 
 
69
 
      <declared>[[importString]]</declared>
70
 
          
71
 
[[if mainInterface.conformedProtocols.count > 0]]
72
 
          [[foreach protocolName mainInterface.conformedProtocols prot1]]
73
 
                <conform>[[protocolName]]</conform>
74
 
                  [[endforeach prot1]]
75
 
          [[endif conformedProtocols]]
76
 
[[endif hasMainInterface == 1]]
77
 
 
78
 
 
79
 
 
80
 
 
81
 
[[if hasMainInterface == 1]]
82
 
<desc>
83
 
                [[mainInterface.interfaceTitle]] Description - 
84
 
                [[mainInterface.entityDescription.formattedCommentString]]
85
 
          </desc>
86
 
[[endif hasMainInterface == 1]]
87
 
 
88
 
[[if hasMainInterface != 0]][[comment - Everything else is only done if we have an interface]]
89
 
 
90
 
 
91
 
 
92
 
 
93
 
[[if mainInterface.interfaceTitle == Class]]
94
 
[[if mainInterface.ivarArray.count > 0]]
95
 
        [[comment Instance Variables]]
96
 
        [[foreach ivar mainInterface.ivarArray ivar1]]
97
 
                <ivariable name="[[ivar.fullName]]" type="[[ivar.formattedType]]" posttype="[[ivar.posttype]]">
98
 
<desc>[[ivar.entityDescription.formattedCommentString]]</desc>
99
 
</ivariable>
100
 
    [[endforeach ivar1]]
101
 
[[endif ivarArray]][[endif Class]]
102
 
 
103
 
 
104
 
 
105
 
 
106
 
 
107
 
[[if mainInterface.classMethods.count > 0]]
108
 
        [[comment Class Methods]]
109
 
        [[foreach method mainInterface.classMethods method1]]
110
 
                [[if methodIndex > 0]] [[comment Start]] [[endif]]
111
 
                [[comment <uref url="//apple_ref/occ/[[if mainInterface.interfaceTitle ==  Protocol]]intfm[[else]]clm[[endif]]/[[mainTitle]]/[[method.selectorName]]"></uref>
112
 
        <uref url="[[method.methodName]]">[[method.selectorName]]</uref>]]
113
 
[[comment +]]<method type="[[method.formattedReturnType]]" factory="yes">
114
 
       [[if method.argumentCount == 0]]
115
 
          <sel>[[method.selectorName]]</sel>
116
 
       [[else]]
117
 
          [[foreach arg method.arguments arg1]]
118
 
              [[if argIndex > 0]] [[endif]]
119
 
              <sel>[[arg.argName]]:</sel>
120
 
              <arg type="[[arg.argType]]">[[arg.varName]]</arg>
121
 
          [[endforeach arg1]]
122
 
                [[endif]]
123
 
                <desc>[[method.entityDescription.formattedCommentString]]</desc>
124
 
</method>
125
 
                [[if methodIndex > 0]] [[comment Stop]] [[endif]]
126
 
        [[endforeach method1]]
127
 
[[endif classMethods]]
128
 
 
129
 
 
130
 
[[if mainInterface.instanceMethods.count > 0]] 
131
 
        [[comment Instance Methods]]
132
 
        [[foreach method mainInterface.instanceMethods method1]]
133
 
                [[if methodIndex > 0]] [[comment Start]] [[endif]]
134
 
                [[comment <uref url="//apple_ref/occ/[[if mainInterface.interfaceTitle == Protocol]]intfm[[else]]instm[[endif]]/[[mainTitle]]/[[method.selectorName]]"></uref>
135
 
        <uref url="[[method.methodName]]">[[method.selectorName]]</uref>]]
136
 
                [[comment -]] <method type="[[method.formattedReturnType]]">
137
 
        [[if method.argumentCount == 0]]
138
 
           <sel>[[method.selectorName]]</sel>
139
 
        [[else]]
140
 
           [[foreach arg method.arguments arg1]]
141
 
                [[if argIndex > 0]] [[endif]]
142
 
           <sel>[[arg.argName]]:</sel>
143
 
           <arg type="[[arg.argType]]">[[arg.varName]]</arg>
144
 
           [[endforeach arg1]]
145
 
                [[endif]]
146
 
                <desc>[[method.entityDescription.formattedCommentString]]</desc>
147
 
</method>
148
 
                [[if methodIndex > 0]] [[comment Stop]] [[endif]]
149
 
        [[endforeach method1]]
150
 
[[endif instanceMethods]]
151
 
 
152
 
          [[if mainInterface.interfaceTitle == Class]]
153
 
      </class>
154
 
      [[else]]
155
 
          [[if mainInterface.interfaceTitle == Category]]
156
 
      </category>
157
 
      [[else]]
158
 
          [[if mainInterface.interfaceTitle == Protocol]]
159
 
      </protocol>
160
 
          [[endif Category]]
161
 
          [[endif Category]]
162
 
          [[endif Class]]
163
 
[[endif hasMainInterface]]
164
 
 
165
 
[[if hasMainInterface == 1]]
166
 
             </chapter>
167
 
[[endif hasMainInterface == 1]]
168
 
 
169
 
 
170
 
 
171
 
 
172
 
[[if typedefArray.count > 0]]
173
 
          <chapter id="#">
174
 
          <heading>Defined Types</heading>
175
 
 
176
 
                [[foreach group typedefGroupArray group4]]
177
 
                                [[foreach typedef group.itemArray typedef1]]
178
 
                                        [[comment <uref url="//apple_ref/c/tdef/[[typedef.name]]">[[typedef.name]]</uref>]]
179
 
                                        <type name="[[typedef.name]]">
180
 
                                          <typespec>[[typedef.formattedValue]][[typedef.suffixValue]]</typespec>
181
 
                                          [[if group.comment.commentString.length > 0]]
182
 
                                                <desc>
183
 
                                                          [[group.comment.formattedCommentString]]
184
 
                                                </desc>
185
 
                                          [[endif commentLength]]
186
 
                                        </type>
187
 
                        [[endforeach typedef1]]
188
 
                [[endforeach group4]]
189
 
</chapter>
190
 
[[endif typedefArray]]
191
 
 
192
 
 
193
 
[[if constantArray.count > 0]]
194
 
          <chapter id="#">
195
 
          <heading>Symbolic Constants</heading>
196
 
                [[foreach group constantGroupArray group5]]
197
 
                          [[foreach constant group.itemArray constant1]]
198
 
                        [[comment <uref url="//apple_ref/c/econst/[[constant.name]]">[[constant.name]]</uref>]]
199
 
<constant name="[[constant.name]]" value="[[constant.formattedValue]]">
200
 
                [[if group.comment.commentString.length > 0]]
201
 
<desc>[[group.comment.formattedCommentString]]</desc>
202
 
                [[endif commentLength]]
203
 
</constant>
204
 
                [[endforeach constant1]]
205
 
        [[endforeach group5]]
206
 
</chapter>
207
 
[[endif constantArray]]
208
 
 
209
 
 
210
 
[[if macroArray.count > 0]]
211
 
          <chapter id="#">
212
 
          <heading>Macro Definitions</heading>
213
 
        [[foreach group macroGroupArray group2]]
214
 
                [[foreach macro group.itemArray macro1]]
215
 
                        <macro name="[[macro.name]]">
216
 
            <arg>[[macro.parameterString]]</arg>
217
 
                [[if group.comment.commentString.length > 0]]
218
 
                <desc>[[group.comment.formattedCommentString]]</desc>
219
 
                [[endif commentLength]]
220
 
</macro>
221
 
                [[endforeach macro1]]
222
 
        [[endforeach group2]]
223
 
</chapter>
224
 
[[endif macroArray]]
225
 
 
226
 
 
227
 
[[if functionArray.count > 0]]
228
 
          <chapter id="#">
229
 
          <heading>Functions</heading>
230
 
        [[foreach group functionGroupArray group3]]
231
 
                [[foreach function group.itemArray function1]]
232
 
[[comment <uref url="//apple_ref/c/func/[[function.name]]">[[function.name]]</uref>]]
233
 
<function name="[[function.name]]" type="[[function.formattedType]]">
234
 
<desc><p>[[function.formattedParameterString]]</p>
235
 
                [[if group.comment.commentString.length > 0]]
236
 
<p>[[group.comment.formattedCommentString]]</p>
237
 
                [[endif commentLength]]</desc></function>
238
 
                [[endforeach function1]]
239
 
        [[endforeach group3]]
240
 
</chapter>
241
 
[[endif functionArray]]
242
 
 
243
 
 
244
 
[[if inlineFunctionArray.count > 0]]
245
 
          <chapter id="#">
246
 
          <heading>Static Inline Functions</heading>
247
 
        [[foreach group inlineFunctionGroupArray group3]]
248
 
                [[foreach function group.itemArray function1]]
249
 
[[comment <uref url="//apple_ref/c/func/[[function.name]]">[[function.name]]</uref>]]
250
 
<function name="[[function.name]]" type="[[function.formattedType]]">
251
 
<desc><p>[[function.formattedParameterString]]<</p>
252
 
                [[if group.comment.commentString.length > 0]]
253
 
<p>[[group.comment.formattedCommentString]]</p>
254
 
                [[endif commentLength]]</desc></function>
255
 
                [[endforeach function1]]
256
 
        [[endforeach group3]]
257
 
</chapter>
258
 
[[endif inlineFunctionArray]]
259
 
 
260
 
 
261
 
[[if variableArray.count > 0]]
262
 
    <chapter id="#">
263
 
        <heading>Global Variables</heading>
264
 
        [[foreach group variableGroupArray group6]]
265
 
                [[foreach global group.itemArray global1]]
266
 
[[comment <uref url="//apple_ref/c/data/[[global.name]]">[[global.name]]</uref>]]
267
 
<variable name="[[global.name]]" type="[[global.formattedType]]" posttype="[[global.posttype]]">
268
 
                [[if group.comment.commentString.length > 0]]
269
 
<desc>[[group.comment.formattedCommentString]]</desc>
270
 
                [[endif commentLength]]
271
 
</variable>
272
 
                [[endforeach global1]]
273
 
        [[endforeach group6]]
274
 
        </chapter>
275
 
[[endif variableArray]]
276
 
        </body>
277
 
  </gsdoc>
278
 
 
279