← Back to branch summary

~ubuntu-branches/ubuntu/saucy/lazarus/saucy

« back to all changes in this revision

Viewing changes to examples/fpdocmanager/docs/umakeskel.xml

  • Committer: Package Import Robot
  • Author(s): Paul Gevers, Abou Al Montacir, Bart Martens, Paul Gevers
  • Date: 2013-06-08 14:12:17 UTC
  • mfrom: (1.1.9)
  • Revision ID: package-import@ubuntu.com-20130608141217-7k0cy9id8ifcnutc
Tags: 1.0.8+dfsg-1
http://bugs.debian.org/708695
[ Abou Al Montacir ]
* New upstream major release and multiple maintenace release offering many
  fixes and new features marking a new milestone for the Lazarus development
  and its stability level.
  - The detailed list of changes can be found here:
    http://wiki.lazarus.freepascal.org/Lazarus_1.0_release_notes
    http://wiki.lazarus.freepascal.org/Lazarus_1.0_fixes_branch
* LCL changes:
  - LCL is now a normal package.
      + Platform independent parts of the LCL are now in the package LCLBase
      + LCL is automatically recompiled when switching the target platform,
        unless pre-compiled binaries for this target are already installed.
      + No impact on existing projects.
      + Linker options needed by LCL are no more added to projects that do
        not use the LCL package.
  - Minor changes in LCL basic classes behaviour
      + TCustomForm.Create raises an exception if a form resource is not
        found.
      + TNotebook and TPage: a new implementation of these classes was added.
      + TDBNavigator: It is now possible to have focusable buttons by setting
        Options = [navFocusableButtons] and TabStop = True, useful for
        accessibility and for devices with neither mouse nor touch screen.
      + Names of TControlBorderSpacing.GetSideSpace and GetSpace were swapped
        and are now consistent. GetSideSpace = Around + GetSpace.
      + TForm.WindowState=wsFullscreen was added
      + TCanvas.TextFitInfo was added to calculate how many characters will
        fit into a specified Width. Useful for word-wrapping calculations.
      + TControl.GetColorResolvingParent and
        TControl.GetRGBColorResolvingParent were added, simplifying the work
        to obtain the final color of the control while resolving clDefault
        and the ParentColor.
      + LCLIntf.GetTextExtentExPoint now has a good default implementation
        which works in any platform not providing a specific implementation.
        However, Widgetset specific implementation is better, when available.
      + TTabControl was reorganized. Now it has the correct class hierarchy
        and inherits from TCustomTabControl as it should.
  - New unit in the LCL:
      + lazdialogs.pas: adds non-native versions of various native dialogs,
        for example TLazOpenDialog, TLazSaveDialog, TLazSelectDirectoryDialog.
        It is used by widgetsets which either do not have a native dialog, or
        do not wish to use it because it is limited. These dialogs can also be
        used by user applications directly.
      + lazdeviceapis.pas: offers an interface to more hardware devices such
        as the accelerometer, GPS, etc. See LazDeviceAPIs
      + lazcanvas.pas: provides a TFPImageCanvas descendent implementing
        drawing in a LCL-compatible way, but 100% in Pascal.
      + lazregions.pas. LazRegions is a wholly Pascal implementation of
        regions for canvas clipping, event clipping, finding in which control
        of a region tree one an event should reach, for drawing polygons, etc.
      + customdrawncontrols.pas, customdrawndrawers.pas,
        customdrawn_common.pas, customdrawn_android.pas and
        customdrawn_winxp.pas: are the Lazarus Custom Drawn Controls -controls
        which imitate the standard LCL ones, but with the difference that they
        are non-native and support skinning.
  - New APIs added to the LCL to improve support of accessibility software
    such as screen readers.
* IDE changes:
  - Many improvments.
  - The detailed list of changes can be found here:
    http://wiki.lazarus.freepascal.org/New_IDE_features_since#v1.0_.282012-08-29.29
    http://wiki.lazarus.freepascal.org/Lazarus_1.0_release_notes#IDE_Changes
* Debugger / Editor changes:
  - Added pascal sources and breakpoints to the disassembler
  - Added threads dialog.
* Components changes:
  - TAChart: many fixes and new features
  - CodeTool: support Delphi style generics and new syntax extensions.
  - AggPas: removed to honor free licencing. (Closes: Bug#708695)
[Bart Martens]
* New debian/watch file fixing issues with upstream RC release.
[Abou Al Montacir]
* Avoid changing files in .pc hidden directory, these are used by quilt for
  internal purpose and could lead to surprises during build.
[Paul Gevers]
* Updated get-orig-source target and it compinion script orig-tar.sh so that they
  repack the source file, allowing bug 708695 to be fixed.

Show diffs side-by-side

added added

removed removed

Lines of Context:
examples/fpdocmanager/docs/umakeskel.xml
 
1
<?xml version="1.0"?>
 
2
<fpdoc-descriptions>
 
3
  <package name="fpdocmanager">
 
4
    <!--
 
5
  ====================================================================
 
6
    umakeskel
 
7
  ====================================================================
 
8
-->
 
9
    <module name="umakeskel">
 
10
      <short>An extract from the FPC MakeSkel program, with some extensions.
 
11
</short>
 
12
      <descr>TFPDocMaker extends FPDoc TFPDocCreator, with ability to update the XML files.
 
13
 
 
14
</descr>
 
15
      <!-- resource string Visibility: default -->
 
16
      <element name="STitle">
 
17
        <short/>
 
18
        <descr/>
 
19
        <seealso/>
 
20
      </element>
 
21
      <!-- resource string Visibility: default -->
 
22
      <element name="SVersion">
 
23
        <short/>
 
24
        <descr/>
 
25
        <seealso/>
 
26
      </element>
 
27
      <!-- resource string Visibility: default -->
 
28
      <element name="SCopyright">
 
29
        <short/>
 
30
        <descr/>
 
31
        <seealso/>
 
32
      </element>
 
33
      <!-- resource string Visibility: default -->
 
34
      <element name="SCmdLineHelp">
 
35
        <short/>
 
36
        <descr/>
 
37
        <seealso/>
 
38
      </element>
 
39
      <!-- resource string Visibility: default -->
 
40
      <element name="SCmdLineInvalidOption">
 
41
        <short/>
 
42
        <descr/>
 
43
        <seealso/>
 
44
      </element>
 
45
      <!-- resource string Visibility: default -->
 
46
      <element name="SNoPackageNameProvided">
 
47
        <short/>
 
48
        <descr/>
 
49
        <seealso/>
 
50
      </element>
 
51
      <!-- resource string Visibility: default -->
 
52
      <element name="SOutputMustNotBeDescr">
 
53
        <short/>
 
54
        <descr/>
 
55
        <seealso/>
 
56
      </element>
 
57
      <!-- resource string Visibility: default -->
 
58
      <element name="SCreatingNewNode">
 
59
        <short/>
 
60
        <descr/>
 
61
        <seealso/>
 
62
      </element>
 
63
      <!-- resource string Visibility: default -->
 
64
      <element name="SNodeNotReferenced">
 
65
        <short/>
 
66
        <descr/>
 
67
        <seealso/>
 
68
      </element>
 
69
      <!-- resource string Visibility: default -->
 
70
      <element name="SDone">
 
71
        <short/>
 
72
        <descr/>
 
73
        <seealso/>
 
74
      </element>
 
75
      <!-- resource string Visibility: default -->
 
76
      <element name="SErrInvalidRootNode">
 
77
        <short/>
 
78
        <descr/>
 
79
        <seealso/>
 
80
      </element>
 
81
      <!-- resource string Visibility: default -->
 
82
      <element name="SErrNoPackagesNode">
 
83
        <short/>
 
84
        <descr/>
 
85
        <seealso/>
 
86
      </element>
 
87
      <!-- enumeration type Visibility: default -->
 
88
      <element name="TCmdLineAction">
 
89
        <short/>
 
90
        <descr/>
 
91
        <seealso/>
 
92
      </element>
 
93
      <!-- enumeration value Visibility: default -->
 
94
      <element name="TCmdLineAction.actionHelp">
 
95
        <short/>
 
96
      </element>
 
97
      <!-- enumeration value Visibility: default -->
 
98
      <element name="TCmdLineAction.actionConvert">
 
99
        <short/>
 
100
      </element>
 
101
      <!-- class Visibility: default -->
 
102
      <element name="TCmdOptions">
 
103
        <short/>
 
104
        <descr/>
 
105
        <errors/>
 
106
        <seealso/>
 
107
      </element>
 
108
      <!-- variable Visibility: public -->
 
109
      <element name="TCmdOptions.WriteDeclaration">
 
110
        <short>Emit declaration for elements (--emit-declaration).</short>
 
111
        <descr/>
 
112
        <seealso/>
 
113
      </element>
 
114
      <!-- variable Visibility: public -->
 
115
      <element name="TCmdOptions.UpdateMode">
 
116
        <short>Specifies the MakeSkel engine mode (create skeleton or update file).</short>
 
117
        <descr/>
 
118
        <seealso/>
 
119
      </element>
 
120
      <!-- variable Visibility: public -->
 
121
      <element name="TCmdOptions.SortNodes">
 
122
        <short>Sorts the Element nodes when True.</short>
 
123
        <descr/>
 
124
        <seealso/>
 
125
      </element>
 
126
      <!-- variable Visibility: public -->
 
127
      <element name="TCmdOptions.DisableOverride">
 
128
        <short>Do not create nodes for override methods.</short>
 
129
        <descr/>
 
130
        <seealso/>
 
131
      </element>
 
132
      <!-- variable Visibility: public -->
 
133
      <element name="TCmdOptions.DisableErrors">
 
134
        <short>Suppress Errors sections?</short>
 
135
        <descr/>
 
136
        <seealso/>
 
137
      </element>
 
138
      <!-- variable Visibility: public -->
 
139
      <element name="TCmdOptions.DisableSeealso">
 
140
        <short>Suppress SeeAlso sections?</short>
 
141
        <descr/>
 
142
        <seealso/>
 
143
      </element>
 
144
      <!-- variable Visibility: public -->
 
145
      <element name="TCmdOptions.DisableArguments">
 
146
        <short>Suppress subroutine parameter entries?</short>
 
147
        <descr/>
 
148
        <seealso/>
 
149
      </element>
 
150
      <!-- variable Visibility: public -->
 
151
      <element name="TCmdOptions.DisableProtected">
 
152
        <short>Suppress Elements for protected class members?</short>
 
153
        <descr/>
 
154
        <seealso/>
 
155
      </element>
 
156
      <!-- variable Visibility: public -->
 
157
      <element name="TCmdOptions.DisablePrivate">
 
158
        <short>Suppress Elements for private class members?</short>
 
159
        <descr/>
 
160
        <seealso/>
 
161
      </element>
 
162
      <!-- variable Visibility: public -->
 
163
      <element name="TCmdOptions.DisableFunctionResults">
 
164
        <short>Suppress Elements for function results?</short>
 
165
        <descr/>
 
166
        <seealso/>
 
167
      </element>
 
168
      <!-- variable Visibility: public -->
 
169
      <element name="TCmdOptions.EmitClassSeparator">
 
170
        <short>Generate class separator comment?</short>
 
171
        <descr/>
 
172
        <seealso/>
 
173
      </element>
 
174
      <!-- class Visibility: default -->
 
175
      <element name="TSkelEngine">
 
176
        <short>The MakeSkel engine, used to create documentation skeleton or update files.</short>
 
177
        <descr>It is based on TFPDocEngine, used by FPDoc.</descr>
 
178
        <errors/>
 
179
        <seealso/>
 
180
      </element>
 
181
      <!-- variable Visibility: private -->
 
182
      <element name="TSkelEngine.FEmittedList">
 
183
        <short/>
 
184
        <descr/>
 
185
        <seealso/>
 
186
      </element>
 
187
      <!-- variable Visibility: private -->
 
188
      <element name="TSkelEngine.FNodeList">
 
189
        <short/>
 
190
        <descr/>
 
191
        <seealso/>
 
192
      </element>
 
193
      <!-- variable Visibility: private -->
 
194
      <element name="TSkelEngine.FModules">
 
195
        <short/>
 
196
        <descr/>
 
197
        <seealso/>
 
198
      </element>
 
199
      <!-- variable Visibility: private -->
 
200
      <element name="TSkelEngine.FOptions">
 
201
        <short/>
 
202
        <descr/>
 
203
        <seealso/>
 
204
      </element>
 
205
      <!-- procedure Visibility: private -->
 
206
      <element name="TSkelEngine.DoWriteUnReferencedNodes">
 
207
        <short/>
 
208
        <descr/>
 
209
        <errors/>
 
210
        <seealso/>
 
211
      </element>
 
212
      <!-- argument Visibility: default -->
 
213
      <element name="TSkelEngine.DoWriteUnReferencedNodes.N">
 
214
        <short/>
 
215
      </element>
 
216
      <!-- argument Visibility: default -->
 
217
      <element name="TSkelEngine.DoWriteUnReferencedNodes.NodePath">
 
218
        <short/>
 
219
      </element>
 
220
      <!-- procedure Visibility: private -->
 
221
      <element name="TSkelEngine.SetOptions">
 
222
        <short/>
 
223
        <descr/>
 
224
        <errors/>
 
225
        <seealso/>
 
226
      </element>
 
227
      <!-- argument Visibility: default -->
 
228
      <element name="TSkelEngine.SetOptions.AValue">
 
229
        <short/>
 
230
      </element>
 
231
      <!-- destructor Visibility: public -->
 
232
      <element name="TSkelEngine.Destroy">
 
233
        <short/>
 
234
        <descr/>
 
235
        <errors/>
 
236
        <seealso/>
 
237
      </element>
 
238
      <!-- function Visibility: public -->
 
239
      <element name="TSkelEngine.MustWriteElement">
 
240
        <short/>
 
241
        <descr/>
 
242
        <errors/>
 
243
        <seealso/>
 
244
      </element>
 
245
      <!-- function result Visibility: default -->
 
246
      <element name="TSkelEngine.MustWriteElement.Result">
 
247
        <short/>
 
248
      </element>
 
249
      <!-- argument Visibility: default -->
 
250
      <element name="TSkelEngine.MustWriteElement.El">
 
251
        <short/>
 
252
      </element>
 
253
      <!-- argument Visibility: default -->
 
254
      <element name="TSkelEngine.MustWriteElement.Full">
 
255
        <short/>
 
256
      </element>
 
257
      <!-- function Visibility: public -->
 
258
      <element name="TSkelEngine.WriteElement">
 
259
        <short/>
 
260
        <descr/>
 
261
        <errors/>
 
262
        <seealso/>
 
263
      </element>
 
264
      <!-- function result Visibility: default -->
 
265
      <element name="TSkelEngine.WriteElement.Result">
 
266
        <short/>
 
267
      </element>
 
268
      <!-- argument Visibility: default -->
 
269
      <element name="TSkelEngine.WriteElement.F">
 
270
        <short/>
 
271
      </element>
 
272
      <!-- argument Visibility: default -->
 
273
      <element name="TSkelEngine.WriteElement.El">
 
274
        <short/>
 
275
      </element>
 
276
      <!-- argument Visibility: default -->
 
277
      <element name="TSkelEngine.WriteElement.ADocNode">
 
278
        <short/>
 
279
      </element>
 
280
      <!-- function Visibility: public -->
 
281
      <element name="TSkelEngine.FindModule">
 
282
        <short>Provides dummy modules for all external units.</short>
 
283
        <descr/>
 
284
        <errors/>
 
285
        <seealso/>
 
286
      </element>
 
287
      <!-- function result Visibility: default -->
 
288
      <element name="TSkelEngine.FindModule.Result">
 
289
        <short/>
 
290
      </element>
 
291
      <!-- argument Visibility: default -->
 
292
      <element name="TSkelEngine.FindModule.AName">
 
293
        <short/>
 
294
      </element>
 
295
      <!-- function Visibility: public -->
 
296
      <element name="TSkelEngine.CreateElement">
 
297
        <short/>
 
298
        <descr/>
 
299
        <errors/>
 
300
        <seealso/>
 
301
      </element>
 
302
      <!-- function result Visibility: default -->
 
303
      <element name="TSkelEngine.CreateElement.Result">
 
304
        <short/>
 
305
      </element>
 
306
      <!-- argument Visibility: default -->
 
307
      <element name="TSkelEngine.CreateElement.AClass">
 
308
        <short/>
 
309
      </element>
 
310
      <!-- argument Visibility: default -->
 
311
      <element name="TSkelEngine.CreateElement.AName">
 
312
        <short/>
 
313
      </element>
 
314
      <!-- argument Visibility: default -->
 
315
      <element name="TSkelEngine.CreateElement.AParent">
 
316
        <short/>
 
317
      </element>
 
318
      <!-- argument Visibility: default -->
 
319
      <element name="TSkelEngine.CreateElement.AVisibility">
 
320
        <short/>
 
321
      </element>
 
322
      <!-- argument Visibility: default -->
 
323
      <element name="TSkelEngine.CreateElement.ASourceFilename">
 
324
        <short/>
 
325
      </element>
 
326
      <!-- argument Visibility: default -->
 
327
      <element name="TSkelEngine.CreateElement.ASourceLinenumber">
 
328
        <short/>
 
329
      </element>
 
330
      <!-- procedure Visibility: public -->
 
331
      <element name="TSkelEngine.WriteUnReferencedNodes">
 
332
        <short/>
 
333
        <descr/>
 
334
        <errors/>
 
335
        <seealso/>
 
336
      </element>
 
337
      <!-- procedure Visibility: public -->
 
338
      <element name="TSkelEngine.WriteNodes">
 
339
        <short/>
 
340
        <descr/>
 
341
        <errors/>
 
342
        <seealso/>
 
343
      </element>
 
344
      <!-- argument Visibility: default -->
 
345
      <element name="TSkelEngine.WriteNodes.F">
 
346
        <short/>
 
347
      </element>
 
348
      <!-- argument Visibility: default -->
 
349
      <element name="TSkelEngine.WriteNodes.AModule">
 
350
        <short/>
 
351
      </element>
 
352
      <!-- argument Visibility: default -->
 
353
      <element name="TSkelEngine.WriteNodes.List">
 
354
        <short/>
 
355
      </element>
 
356
      <!-- procedure Visibility: public -->
 
357
      <element name="TSkelEngine.DocumentFile">
 
358
        <short>Writes the skeleton or update elements for AFileName into the XML text file.</short>
 
359
        <descr/>
 
360
        <errors/>
 
361
        <seealso/>
 
362
      </element>
 
363
      <!-- argument Visibility: default -->
 
364
      <element name="TSkelEngine.DocumentFile.F">
 
365
        <short/>
 
366
      </element>
 
367
      <!-- argument Visibility: default -->
 
368
      <element name="TSkelEngine.DocumentFile.AFileName">
 
369
        <short/>
 
370
      </element>
 
371
      <!-- argument Visibility: default -->
 
372
      <element name="TSkelEngine.DocumentFile.ATarget">
 
373
        <short/>
 
374
      </element>
 
375
      <!-- argument Visibility: default -->
 
376
      <element name="TSkelEngine.DocumentFile.ACPU">
 
377
        <short/>
 
378
      </element>
 
379
      <!-- property Visibility: public -->
 
380
      <element name="TSkelEngine.NodeList">
 
381
        <short/>
 
382
        <descr/>
 
383
        <seealso/>
 
384
      </element>
 
385
      <!-- property Visibility: public -->
 
386
      <element name="TSkelEngine.EmittedList">
 
387
        <short/>
 
388
        <descr/>
 
389
        <seealso/>
 
390
      </element>
 
391
      <!-- property Visibility: public -->
 
392
      <element name="TSkelEngine.Options">
 
393
        <short>The general commandline options for MakeSkel.</short>
 
394
        <descr/>
 
395
        <seealso/>
 
396
      </element>
 
397
      <!-- function type Visibility: default -->
 
398
      <element name="THandleOption">
 
399
        <short>Type of an OnOption handler for unknown commanline options.</short>
 
400
        <descr/>
 
401
        <seealso/>
 
402
      </element>
 
403
      <!-- function result Visibility: default -->
 
404
      <element name="THandleOption.Result">
 
405
        <short/>
 
406
      </element>
 
407
      <!-- argument Visibility: default -->
 
408
      <element name="THandleOption.Cmd">
 
409
        <short/>
 
410
      </element>
 
411
      <!-- argument Visibility: default -->
 
412
      <element name="THandleOption.Arg">
 
413
        <short/>
 
414
      </element>
 
415
      <!-- enumeration type Visibility: default -->
 
416
      <element name="TCreatorAction">
 
417
        <short>The action to perform after all FPDoc commandline options have been parsed.</short>
 
418
        <descr>Values returned by the option parsers for every single option. In this case caInvalid indicates an unhandled option.</descr>
 
419
        <seealso/>
 
420
      </element>
 
421
      <!-- enumeration value Visibility: default -->
 
422
      <element name="TCreatorAction.caDefault">
 
423
        <short>Default processing, option parsed successfully.</short>
 
424
      </element>
 
425
      <!-- enumeration value Visibility: default -->
 
426
      <element name="TCreatorAction.caDryRun">
 
427
        <short>DryRun option (-n) found.</short>
 
428
      </element>
 
429
      <!-- enumeration value Visibility: default -->
 
430
      <element name="TCreatorAction.caUsage">
 
431
        <short>Show usage, after option errors.</short>
 
432
      </element>
 
433
      <!-- enumeration value Visibility: default -->
 
434
      <element name="TCreatorAction.caInvalid">
 
435
        <short>Unhandled option found.</short>
 
436
      </element>
 
437
      <!-- enumeration value Visibility: default -->
 
438
      <element name="TCreatorAction.caWriteProject">
 
439
        <short>Write project file instead of documents.</short>
 
440
      </element>
 
441
      <!-- class Visibility: default -->
 
442
      <element name="TFPDocMaker">
 
443
        <short>FPDoc and MakeSkel functionality as a class.</short>
 
444
        <descr/>
 
445
        <errors/>
 
446
        <seealso/>
 
447
      </element>
 
448
      <!-- variable Visibility: private -->
 
449
      <element name="TFPDocMaker.FDescrDir">
 
450
        <short/>
 
451
        <descr/>
 
452
        <seealso/>
 
453
      </element>
 
454
      <!-- variable Visibility: private -->
 
455
      <element name="TFPDocMaker.FInputDir">
 
456
        <short/>
 
457
        <descr/>
 
458
        <seealso/>
 
459
      </element>
 
460
      <!-- variable Visibility: private -->
 
461
      <element name="TFPDocMaker.FOnOption">
 
462
        <short/>
 
463
        <descr/>
 
464
        <seealso/>
 
465
      </element>
 
466
      <!-- variable Visibility: private -->
 
467
      <element name="TFPDocMaker.FOptions">
 
468
        <short/>
 
469
        <descr/>
 
470
        <seealso/>
 
471
      </element>
 
472
      <!-- function Visibility: private -->
 
473
      <element name="TFPDocMaker.GetDescrDir">
 
474
        <short/>
 
475
        <descr/>
 
476
        <errors/>
 
477
        <seealso/>
 
478
      </element>
 
479
      <!-- function result Visibility: default -->
 
480
      <element name="TFPDocMaker.GetDescrDir.Result">
 
481
        <short/>
 
482
      </element>
 
483
      <!-- function Visibility: private -->
 
484
      <element name="TFPDocMaker.GetInputDir">
 
485
        <short/>
 
486
        <descr/>
 
487
        <errors/>
 
488
        <seealso/>
 
489
      </element>
 
490
      <!-- function result Visibility: default -->
 
491
      <element name="TFPDocMaker.GetInputDir.Result">
 
492
        <short/>
 
493
      </element>
 
494
      <!-- procedure Visibility: private -->
 
495
      <element name="TFPDocMaker.SetDescrDir">
 
496
        <short/>
 
497
        <descr/>
 
498
        <errors/>
 
499
        <seealso/>
 
500
      </element>
 
501
      <!-- argument Visibility: default -->
 
502
      <element name="TFPDocMaker.SetDescrDir.AValue">
 
503
        <short/>
 
504
      </element>
 
505
      <!-- procedure Visibility: private -->
 
506
      <element name="TFPDocMaker.SetInputDir">
 
507
        <short/>
 
508
        <descr/>
 
509
        <errors/>
 
510
        <seealso/>
 
511
      </element>
 
512
      <!-- argument Visibility: default -->
 
513
      <element name="TFPDocMaker.SetInputDir.AValue">
 
514
        <short/>
 
515
      </element>
 
516
      <!-- procedure Visibility: private -->
 
517
      <element name="TFPDocMaker.SetOnOption">
 
518
        <short/>
 
519
        <descr/>
 
520
        <errors/>
 
521
        <seealso/>
 
522
      </element>
 
523
      <!-- argument Visibility: default -->
 
524
      <element name="TFPDocMaker.SetOnOption.AValue">
 
525
        <short/>
 
526
      </element>
 
527
      <!-- procedure Visibility: private -->
 
528
      <element name="TFPDocMaker.SetOptions">
 
529
        <short/>
 
530
        <descr/>
 
531
        <errors/>
 
532
        <seealso/>
 
533
      </element>
 
534
      <!-- argument Visibility: default -->
 
535
      <element name="TFPDocMaker.SetOptions.AValue">
 
536
        <short/>
 
537
      </element>
 
538
      <!-- variable Visibility: protected -->
 
539
      <element name="TFPDocMaker.FCmdAction">
 
540
        <short/>
 
541
        <descr/>
 
542
        <seealso/>
 
543
      </element>
 
544
      <!-- variable Visibility: protected -->
 
545
      <element name="TFPDocMaker.FDryRun">
 
546
        <short/>
 
547
        <descr/>
 
548
        <seealso/>
 
549
      </element>
 
550
      <!-- variable Visibility: protected -->
 
551
      <element name="TFPDocMaker.FPackage">
 
552
        <short/>
 
553
        <descr/>
 
554
        <seealso/>
 
555
      </element>
 
556
      <!-- variable Visibility: protected -->
 
557
      <element name="TFPDocMaker.FProjectFile">
 
558
        <short/>
 
559
        <descr/>
 
560
        <seealso/>
 
561
      </element>
 
562
      <!-- variable Visibility: protected -->
 
563
      <element name="TFPDocMaker.FWriteProjectFile">
 
564
        <short/>
 
565
        <descr/>
 
566
        <seealso/>
 
567
      </element>
 
568
      <!-- variable Visibility: protected -->
 
569
      <element name="TFPDocMaker.FTranslated">
 
570
        <short/>
 
571
        <descr/>
 
572
        <seealso/>
 
573
      </element>
 
574
      <!-- procedure Visibility: protected -->
 
575
      <element name="TFPDocMaker.SetCmdAction">
 
576
        <short/>
 
577
        <descr/>
 
578
        <errors/>
 
579
        <seealso/>
 
580
      </element>
 
581
      <!-- argument Visibility: default -->
 
582
      <element name="TFPDocMaker.SetCmdAction.AValue">
 
583
        <short/>
 
584
      </element>
 
585
      <!-- procedure Visibility: protected -->
 
586
      <element name="TFPDocMaker.SetDryRun">
 
587
        <short/>
 
588
        <descr/>
 
589
        <errors/>
 
590
        <seealso/>
 
591
      </element>
 
592
      <!-- argument Visibility: default -->
 
593
      <element name="TFPDocMaker.SetDryRun.AValue">
 
594
        <short/>
 
595
      </element>
 
596
      <!-- procedure Visibility: protected -->
 
597
      <element name="TFPDocMaker.SetPackage">
 
598
        <short/>
 
599
        <descr/>
 
600
        <errors/>
 
601
        <seealso/>
 
602
      </element>
 
603
      <!-- argument Visibility: default -->
 
604
      <element name="TFPDocMaker.SetPackage.AValue">
 
605
        <short/>
 
606
      </element>
 
607
      <!-- procedure Visibility: protected -->
 
608
      <element name="TFPDocMaker.SetWriteProjectFile">
 
609
        <short/>
 
610
        <descr/>
 
611
        <errors/>
 
612
        <seealso/>
 
613
      </element>
 
614
      <!-- argument Visibility: default -->
 
615
      <element name="TFPDocMaker.SetWriteProjectFile.AValue">
 
616
        <short/>
 
617
      </element>
 
618
      <!-- function Visibility: protected -->
 
619
      <element name="TFPDocMaker.ParseCommon">
 
620
        <short>Parses options common to FPDoc and MakeSkel. Returns caInvalid for unknown options.</short>
 
621
        <descr>Raw options, where Cmd contains name=value, are splitted into Cmd and Arg. Quotes around/in Arg are removed, needed to process scripts.</descr>
 
622
        <errors/>
 
623
        <seealso/>
 
624
      </element>
 
625
      <!-- function result Visibility: default -->
 
626
      <element name="TFPDocMaker.ParseCommon.Result">
 
627
        <short/>
 
628
      </element>
 
629
      <!-- argument Visibility: default -->
 
630
      <element name="TFPDocMaker.ParseCommon.Cmd">
 
631
        <short/>
 
632
      </element>
 
633
      <!-- argument Visibility: default -->
 
634
      <element name="TFPDocMaker.ParseCommon.Arg">
 
635
        <short/>
 
636
      </element>
 
637
      <!-- function Visibility: public -->
 
638
      <element name="TFPDocMaker.DocumentPackage">
 
639
        <short>Creates or updates XML documentation sources (MakeSkel emulation)</short>
 
640
        <descr/>
 
641
        <errors/>
 
642
        <seealso/>
 
643
      </element>
 
644
      <!-- function result Visibility: default -->
 
645
      <element name="TFPDocMaker.DocumentPackage.Result">
 
646
        <short/>
 
647
      </element>
 
648
      <!-- argument Visibility: default -->
 
649
      <element name="TFPDocMaker.DocumentPackage.APackageName">
 
650
        <short/>
 
651
      </element>
 
652
      <!-- argument Visibility: default -->
 
653
      <element name="TFPDocMaker.DocumentPackage.AOutputName">
 
654
        <short/>
 
655
      </element>
 
656
      <!-- argument Visibility: default -->
 
657
      <element name="TFPDocMaker.DocumentPackage.InputFiles">
 
658
        <short/>
 
659
      </element>
 
660
      <!-- argument Visibility: default -->
 
661
      <element name="TFPDocMaker.DocumentPackage.DescrFiles">
 
662
        <short/>
 
663
      </element>
 
664
      <!-- procedure Visibility: public -->
 
665
      <element name="TFPDocMaker.CreateUnitDocumentation">
 
666
        <short>Creates final documentation, for a package or a single unit (FPDoc emulation).</short>
 
667
        <descr>When an description file exists already for a unit, an <rootdir/>/upd.<unit/>.xml file is created, containing all updates. Empty files are destroyed afterwards.
 
668
Otherwise a skeleton file is created in the descriptions directory.</descr>
 
669
        <errors/>
 
670
        <seealso/>
 
671
      </element>
 
672
      <!-- argument Visibility: default -->
 
673
      <element name="TFPDocMaker.CreateUnitDocumentation.APackage">
 
674
        <short/>
 
675
      </element>
 
676
      <!-- argument Visibility: default -->
 
677
      <element name="TFPDocMaker.CreateUnitDocumentation.AUnit">
 
678
        <short>Update only AUnit if not empty, else the entire package.</short>
 
679
      </element>
 
680
      <!-- argument Visibility: default -->
 
681
      <element name="TFPDocMaker.CreateUnitDocumentation.ParseOnly">
 
682
        <short/>
 
683
      </element>
 
684
      <!-- variable Visibility: public -->
 
685
      <element name="TFPDocMaker.ImportDir">
 
686
        <short/>
 
687
        <descr/>
 
688
        <seealso/>
 
689
      </element>
 
690
      <!-- variable Visibility: public -->
 
691
      <element name="TFPDocMaker.SelectedUnit">
 
692
        <short/>
 
693
        <descr/>
 
694
        <seealso/>
 
695
      </element>
 
696
      <!-- constructor Visibility: public -->
 
697
      <element name="TFPDocMaker.Create">
 
698
        <short/>
 
699
        <descr/>
 
700
        <errors/>
 
701
        <seealso/>
 
702
      </element>
 
703
      <!-- argument Visibility: default -->
 
704
      <element name="TFPDocMaker.Create.AOwner">
 
705
        <short/>
 
706
      </element>
 
707
      <!-- destructor Visibility: public -->
 
708
      <element name="TFPDocMaker.Destroy">
 
709
        <short/>
 
710
        <descr/>
 
711
        <errors/>
 
712
        <seealso/>
 
713
      </element>
 
714
      <!-- procedure Visibility: public -->
 
715
      <element name="TFPDocMaker.AddDirToFileList">
 
716
        <short>Adds files in a directory to a stringlist, using a filename mask.</short>
 
717
        <descr/>
 
718
        <errors/>
 
719
        <seealso/>
 
720
      </element>
 
721
      <!-- argument Visibility: default -->
 
722
      <element name="TFPDocMaker.AddDirToFileList.List">
 
723
        <short/>
 
724
      </element>
 
725
      <!-- argument Visibility: default -->
 
726
      <element name="TFPDocMaker.AddDirToFileList.ADirName">
 
727
        <short/>
 
728
      </element>
 
729
      <!-- argument Visibility: default -->
 
730
      <element name="TFPDocMaker.AddDirToFileList.AMask">
 
731
        <short/>
 
732
      </element>
 
733
      <!-- procedure Visibility: public -->
 
734
      <element name="TFPDocMaker.AddToFileList">
 
735
        <short>Adds lines from an file to a stringlist.</short>
 
736
        <descr/>
 
737
        <errors/>
 
738
        <seealso/>
 
739
      </element>
 
740
      <!-- argument Visibility: default -->
 
741
      <element name="TFPDocMaker.AddToFileList.List">
 
742
        <short/>
 
743
      </element>
 
744
      <!-- argument Visibility: default -->
 
745
      <element name="TFPDocMaker.AddToFileList.FileName">
 
746
        <short/>
 
747
      </element>
 
748
      <!-- function Visibility: public -->
 
749
      <element name="TFPDocMaker.UnitSpec">
 
750
        <short>Returns the full input specification (command options) for a unit in the selected package.</short>
 
751
        <descr/>
 
752
        <errors/>
 
753
        <seealso/>
 
754
      </element>
 
755
      <!-- function result Visibility: default -->
 
756
      <element name="TFPDocMaker.UnitSpec.Result">
 
757
        <short/>
 
758
      </element>
 
759
      <!-- argument Visibility: default -->
 
760
      <element name="TFPDocMaker.UnitSpec.AUnit">
 
761
        <short/>
 
762
      </element>
 
763
      <!-- function Visibility: public -->
 
764
      <element name="TFPDocMaker.ImportName">
 
765
        <short>Returns the package name from an Imports specifier.</short>
 
766
        <descr/>
 
767
        <errors/>
 
768
        <seealso/>
 
769
      </element>
 
770
      <!-- function result Visibility: default -->
 
771
      <element name="TFPDocMaker.ImportName.Result"/>
 
772
      <!-- argument Visibility: default -->
 
773
      <element name="TFPDocMaker.ImportName.AIndex">
 
774
        <short/>
 
775
      </element>
 
776
      <!-- procedure Visibility: public -->
 
777
      <element name="TFPDocMaker.LogToStdOut">
 
778
        <short>Standard OnLog handler, writing to stdout.</short>
 
779
        <descr/>
 
780
        <errors/>
 
781
        <seealso/>
 
782
      </element>
 
783
      <!-- argument Visibility: default -->
 
784
      <element name="TFPDocMaker.LogToStdOut.Sender">
 
785
        <short/>
 
786
      </element>
 
787
      <!-- argument Visibility: default -->
 
788
      <element name="TFPDocMaker.LogToStdOut.msg">
 
789
        <short/>
 
790
      </element>
 
791
      <!-- procedure Visibility: public -->
 
792
      <element name="TFPDocMaker.LogToStdErr">
 
793
        <short>Standard OnLog handler, writing to stderr.</short>
 
794
        <descr/>
 
795
        <errors/>
 
796
        <seealso/>
 
797
      </element>
 
798
      <!-- argument Visibility: default -->
 
799
      <element name="TFPDocMaker.LogToStdErr.Sender">
 
800
        <short/>
 
801
      </element>
 
802
      <!-- argument Visibility: default -->
 
803
      <element name="TFPDocMaker.LogToStdErr.msg">
 
804
        <short/>
 
805
      </element>
 
806
      <!-- function Visibility: public -->
 
807
      <element name="TFPDocMaker.ParseFPDocOption">
 
808
        <short>Parses and stores an FPDoc commanline option.</short>
 
809
        <descr/>
 
810
        <errors/>
 
811
        <seealso/>
 
812
      </element>
 
813
      <!-- function result Visibility: default -->
 
814
      <element name="TFPDocMaker.ParseFPDocOption.Result">
 
815
        <short/>
 
816
      </element>
 
817
      <!-- argument Visibility: default -->
 
818
      <element name="TFPDocMaker.ParseFPDocOption.S">
 
819
        <short/>
 
820
      </element>
 
821
      <!-- function Visibility: public -->
 
822
      <element name="TFPDocMaker.ParseUpdateOption">
 
823
        <short>Parses and stores an MakeSkel commanline option.</short>
 
824
        <descr/>
 
825
        <errors/>
 
826
        <seealso/>
 
827
      </element>
 
828
      <!-- function result Visibility: default -->
 
829
      <element name="TFPDocMaker.ParseUpdateOption.Result">
 
830
        <short/>
 
831
      </element>
 
832
      <!-- argument Visibility: default -->
 
833
      <element name="TFPDocMaker.ParseUpdateOption.S">
 
834
        <short/>
 
835
      </element>
 
836
      <!-- function Visibility: public -->
 
837
      <element name="TFPDocMaker.CheckSkelOptions">
 
838
        <short>Sanity check before starting a MakeSkel operation (DocumentPackage).</short>
 
839
        <descr/>
 
840
        <errors/>
 
841
        <seealso/>
 
842
      </element>
 
843
      <!-- function result Visibility: default -->
 
844
      <element name="TFPDocMaker.CheckSkelOptions.Result">
 
845
        <short/>
 
846
      </element>
 
847
      <!-- function Visibility: public -->
 
848
      <element name="TFPDocMaker.CleanXML">
 
849
        <short>Return True and (try) kill file if no element tag found in it.</short>
 
850
        <descr>Used to remove empty update files after DocumentPackage.</descr>
 
851
        <errors/>
 
852
        <seealso/>
 
853
      </element>
 
854
      <!-- function result Visibility: default -->
 
855
      <element name="TFPDocMaker.CleanXML.Result">
 
856
        <short/>
 
857
      </element>
 
858
      <!-- argument Visibility: default -->
 
859
      <element name="TFPDocMaker.CleanXML.FileName">
 
860
        <short/>
 
861
      </element>
 
862
      <!-- function Visibility: public -->
 
863
      <element name="TFPDocMaker.SelectedPackage">
 
864
        <short>Returns the currently selected package.</short>
 
865
        <descr/>
 
866
        <errors>When no package was specified, a message is logged.</errors>
 
867
        <seealso/>
 
868
      </element>
 
869
      <!-- function result Visibility: default -->
 
870
      <element name="TFPDocMaker.SelectedPackage.Result">
 
871
        <short/>
 
872
      </element>
 
873
      <!-- property Visibility: public -->
 
874
      <element name="TFPDocMaker.Package">
 
875
        <short>The currently selected package.</short>
 
876
        <descr/>
 
877
        <seealso/>
 
878
      </element>
 
879
      <!-- property Visibility: public -->
 
880
      <element name="TFPDocMaker.CmdAction">
 
881
        <short>Action to perform after commandline arguments have been parsed.</short>
 
882
        <descr/>
 
883
        <seealso/>
 
884
      </element>
 
885
      <!-- property Visibility: public -->
 
886
      <element name="TFPDocMaker.DryRun">
 
887
        <short>Allows to perform syntax checks of documentation source files, instead of creating final documentation.</short>
 
888
        <descr/>
 
889
        <seealso/>
 
890
      </element>
 
891
      <!-- property Visibility: public -->
 
892
      <element name="TFPDocMaker.ReadProject">
 
893
        <short>True when a project file has been read (--project option)</short>
 
894
        <descr/>
 
895
        <seealso/>
 
896
      </element>
 
897
      <!-- property Visibility: public -->
 
898
      <element name="TFPDocMaker.WriteProjectFile">
 
899
        <short>The name of an project file to create (--write-project argument)</short>
 
900
        <descr/>
 
901
        <seealso/>
 
902
      </element>
 
903
      <!-- property Visibility: public -->
 
904
      <element name="TFPDocMaker.OnOption">
 
905
        <short>User supplied handler for unknown commandline options.</short>
 
906
        <descr/>
 
907
        <seealso/>
 
908
      </element>
 
909
      <!-- property Visibility: public -->
 
910
      <element name="TFPDocMaker.InputDir">
 
911
        <short>The directory containing Inputs files. Writing adds all source files in the directory to Inputs[].</short>
 
912
        <descr>Can be written more than once, to specify multiple input directories (cumulative).</descr>
 
913
        <seealso/>
 
914
      </element>
 
915
      <!-- property Visibility: public -->
 
916
      <element name="TFPDocMaker.DescrDir">
 
917
        <short>The directory containing Description files. Writing adds all XML files in the directory to Descriptions[].</short>
 
918
        <descr>Can be written more than once, to specify multiple Description directories (cumulative). The first[?] directory is assumed the default directory, for creating and searching description files. [intended to merge files from multiple packages]</descr>
 
919
        <seealso/>
 
920
      </element>
 
921
      <!-- property Visibility: public -->
 
922
      <element name="TFPDocMaker.Options">
 
923
        <short>Holds all parsed FPDoc and MakeSkel commandline options.</short>
 
924
        <descr/>
 
925
        <seealso/>
 
926
      </element>
 
927
      <!-- function Visibility: default -->
 
928
      <element name="GetNextWord">
 
929
        <short>Extracts next commandline option from an string.</short>
 
930
        <descr/>
 
931
        <errors/>
 
932
        <seealso/>
 
933
      </element>
 
934
      <!-- function result Visibility: default -->
 
935
      <element name="GetNextWord.Result">
 
936
        <short/>
 
937
      </element>
 
938
      <!-- argument Visibility: default -->
 
939
      <element name="GetNextWord.s">
 
940
        <short/>
 
941
      </element>
 
942
      <!-- function Visibility: default -->
 
943
      <element name="ExtractImportName">
 
944
        <short>Get package name from an Imports specifier.</short>
 
945
        <descr/>
 
946
        <errors/>
 
947
        <seealso/>
 
948
      </element>
 
949
      <!-- function result Visibility: default -->
 
950
      <element name="ExtractImportName.Result">
 
951
        <short/>
 
952
      </element>
 
953
      <!-- argument Visibility: default -->
 
954
      <element name="ExtractImportName.s">
 
955
        <short/>
 
956
      </element>
 
957
      <!-- function Visibility: default -->
 
958
      <element name="UnitFile">
 
959
        <short>Get an filename from an Inputs or Descriptions list.</short>
 
960
        <descr/>
 
961
        <errors/>
 
962
        <seealso/>
 
963
      </element>
 
964
      <!-- function result Visibility: default -->
 
965
      <element name="UnitFile.Result">
 
966
        <short/>
 
967
      </element>
 
968
      <!-- argument Visibility: default -->
 
969
      <element name="UnitFile.AList">
 
970
        <short/>
 
971
      </element>
 
972
      <!-- argument Visibility: default -->
 
973
      <element name="UnitFile.AIndex">
 
974
        <short/>
 
975
      </element>
 
976
      <!-- function Visibility: default -->
 
977
      <element name="ExtractUnitName">
 
978
        <short>Get the unit name from Inputs or Descriptions, or from an string containing such an element.</short>
 
979
        <descr/>
 
980
        <errors/>
 
981
        <seealso/>
 
982
      </element>
 
983
      <!-- function result Visibility: default -->
 
984
      <element name="ExtractUnitName.Result">
 
985
        <short/>
 
986
      </element>
 
987
      <!-- argument Visibility: default -->
 
988
      <element name="ExtractUnitName.AList">
 
989
        <short/>
 
990
      </element>
 
991
      <!-- argument Visibility: default -->
 
992
      <element name="ExtractUnitName.AIndex">
 
993
        <short/>
 
994
      </element>
 
995
      <!-- argument Visibility: default -->
 
996
      <element name="ExtractUnitName.s">
 
997
        <short/>
 
998
      </element>
 
999
      <element name="TFPDocMaker.CmdOptions">
 
1000
        <short>Combined FPDoc and MakeSkel options. Writing copies the given object into both option sets.</short>
 
1001
      </element>
 
1002
    </module>
 
1003
    <!-- umakeskel -->
 
1004
  </package>
 
1005
</fpdoc-descriptions>