← Back to branch summary

~ubuntu-branches/debian/lenny/fpc/lenny

« back to all changes in this revision

Viewing changes to fpcdocs/dbugmsg.xml

  • Committer: Bazaar Package Importer
  • Author(s): Mazen Neifer, Torsten Werner, Mazen Neifer
  • Date: 2008-05-17 17:12:11 UTC
  • mfrom: (3.1.9 intrepid)
  • Revision ID: james.westby@ubuntu.com-20080517171211-9qi33xhd9evfa0kg
Tags: 2.2.0-dfsg1-9
http://bugs.debian.org/477743
[ Torsten Werner ]
* Add Mazen Neifer to Uploaders field.

[ Mazen Neifer ]
* Moved FPC sources into a version dependent directory from /usr/share/fpcsrc
  to /usr/share/fpcsrc/${FPCVERSION}. This allow installing more than on FPC
  release.
* Fixed far call issue in compiler preventing building huge binearies.
  (closes: #477743)
* Updated building dependencies, recomennded and suggested packages.
* Moved fppkg to fp-utils as it is just a helper tool and is not required by
  compiler.

Show diffs side-by-side

added added

removed removed

Lines of Context:
fpcdocs/dbugmsg.xml
 
1
<?xml version="1.0" encoding="ISO-8859-1"?>
 
2
<fpdoc-descriptions>
 
3
<package name="fcl">
 
4
 
 
5
<!--
 
6
  ====================================================================
 
7
    dbugmsg
 
8
  ====================================================================
 
9
-->
 
10
 
 
11
<module name="dbugmsg">
 
12
<short>Auxiliary unit for the dbugintf unit.</short>
 
13
<descr>
 
14
<file>dbugmsg</file> is an auxialiary unit used in the <link
 
15
id="#fcl.dbugintf">dbugintf</link> unit. It defines the message protocol
 
16
used between the debug unit and the debug server.
 
17
</descr>
 
18
 
 
19
<!-- unresolved type reference Visibility: default -->
 
20
<element name="Classes">
 
21
<short><var>TStream</var> implementation</short>
 
22
</element>
 
23
 
 
24
<!-- constant Visibility: default -->
 
25
<element name="DebugServerID">
 
26
<short>System unique name</short>
 
27
<descr>
 
28
<var>DebugServerID</var> is a string which is used when creating the message
 
29
protocol, it is used when identifying the server in the (platform dependent)
 
30
client-server protocol.
 
31
</descr>
 
32
</element>
 
33
 
 
34
<!-- constant Visibility: default -->
 
35
<element name="lctStop">
 
36
<short>Stop message</short>
 
37
<descr>
 
38
<var>lctStop</var> is sent by the client to a server when it disconnects.
 
39
</descr>
 
40
</element>
 
41
 
 
42
<!-- constant Visibility: default -->
 
43
<element name="lctInformation">
 
44
<short>Informational message</short>
 
45
<descr>
 
46
<var>lctInformation</var> is the identification of informational messages.
 
47
</descr>
 
48
</element>
 
49
 
 
50
<!-- constant Visibility: default -->
 
51
<element name="lctWarning">
 
52
<short>Warning message</short>
 
53
<descr>
 
54
<var>lctWarning</var> is the identification of warning messages.
 
55
</descr>
 
56
</element>
 
57
 
 
58
<!-- constant Visibility: default -->
 
59
<element name="lctError">
 
60
<short>Error message</short>
 
61
<descr>
 
62
<var>lctError</var> is the identification of error messages.
 
63
</descr>
 
64
</element>
 
65
 
 
66
<!-- constant Visibility: default -->
 
67
<element name="lctIdentify">
 
68
<short>Identification message</short>
 
69
<descr>
 
70
<var>lctIdentify</var> is sent by the client to a server when it first connects.
 
71
It's the first message, and contains the name of client application.
 
72
</descr>
 
73
</element>
 
74
 
 
75
<!-- record type Visibility: default -->
 
76
<element name="TDebugMessage">
 
77
<short>Structure describing a message</short>
 
78
<descr>
 
79
<var>TDebugMessage</var> is a record that describes the message passed from
 
80
the client to the server. It should not be passed directly in shared memory,
 
81
as the string containing the message is allocated on the heap. Instead, the
 
82
<link id="WriteDebugMessageToStream"/>  and <link id="ReadDebugMessageFromStream"/>
 
83
can be used to read or write the message from/to a stream.
 
84
</descr>
 
85
<seealso>
 
86
<link id="ReadDebugMessageFromStream"/>
 
87
<link id="WriteDebugMessageToStream"/>
 
88
</seealso>
 
89
</element>
 
90
 
 
91
<!-- variable Visibility: default -->
 
92
<element name="TDebugMessage.MsgType">
 
93
<short>Constant, identifying the type of message</short>
 
94
</element>
 
95
 
 
96
<!-- variable Visibility: default -->
 
97
<element name="TDebugMessage.MsgTimeStamp">
 
98
<short>Time when the message was generated</short>
 
99
</element>
 
100
 
 
101
<!-- variable Visibility: default -->
 
102
<element name="TDebugMessage.Msg">
 
103
<short>String containing the message text.</short>
 
104
</element>
 
105
 
 
106
<!-- procedure Visibility: default -->
 
107
<element name="ReadDebugMessageFromStream">
 
108
<short>Read a message from stream</short>
 
109
<descr>
 
110
<p>
 
111
<var>ReadDebugMessageFromStream</var> reads a <link id="TDebugMessage"/>
 
112
record (<var>Msg</var>) from the stream <var>AStream</var>.
 
113
</p>
 
114
<p>
 
115
The record is not read in a byte-ordering safe way, i.e. it cannot be
 
116
exchanged between little- and big-endian systems.
 
117
</p>
 
118
</descr>
 
119
<errors>
 
120
If the stream contains not enough bytes or is malformed, then an exception
 
121
may be raised.
 
122
</errors>
 
123
<seealso>
 
124
<link id="TDebugMessage"/>
 
125
<link id="WriteDebugMessageToStream"/>
 
126
</seealso>
 
127
</element>
 
128
 
 
129
<!-- argument Visibility: default -->
 
130
<element name="ReadDebugMessageFromStream.AStream">
 
131
<short>Stream from which record is read</short>
 
132
</element>
 
133
 
 
134
<!-- argument Visibility: default -->
 
135
<element name="ReadDebugMessageFromStream.Msg">
 
136
<short>Record to be read from stream</short>
 
137
</element>
 
138
 
 
139
<!-- procedure Visibility: default -->
 
140
<element name="WriteDebugMessageToStream">
 
141
<short>Write a message to stream</short>
 
142
<descr>
 
143
<p>
 
144
<var>WriteDebugMessageFromStream</var> writes a <link id="TDebugMessage"/>
 
145
record (<var>Msg</var>) to the stream <var>AStream</var>.
 
146
</p>
 
147
<p>
 
148
The record is not written in a byte-ordering safe way, i.e. it cannot be
 
149
exchanged between little- and big-endian systems.
 
150
</p>
 
151
</descr>
 
152
<errors>
 
153
A stream write error may occur if the stream cannot be written to.
 
154
</errors>
 
155
<seealso>
 
156
<link id="TDebugMessage"/>
 
157
<link id="ReadDebugMessageToStream"/>
 
158
</seealso>
 
159
</element>
 
160
 
 
161
<!-- argument Visibility: default -->
 
162
<element name="WriteDebugMessageToStream.AStream">
 
163
<short>Stream to write message to</short>
 
164
</element>
 
165
 
 
166
<!-- argument Visibility: default -->
 
167
<element name="WriteDebugMessageToStream.Msg">
 
168
<short>Message record to be written</short>
 
169
</element>
 
170
 
 
171
<!-- function Visibility: default -->
 
172
<element name="DebugMessageName">
 
173
<short>Return the name of the debug message</short>
 
174
<descr>
 
175
<var>DebugMessageName</var> returns the name of the message type. It can be
 
176
used to examine the <var>MsgType</var> field of a <link id="TDebugMessage"/>
 
177
record, and if <var>msgType</var> contains a known type, it returns a
 
178
string describing this type.
 
179
</descr>
 
180
<errors>
 
181
If <var>MsgType</var> contains an unknown type, <var>'Unknown'</var> is
 
182
returned.
 
183
</errors>
 
184
</element>
 
185
 
 
186
<!-- function result Visibility: default -->
 
187
<element name="DebugMessageName.Result">
 
188
<short>String describing the message type</short>
 
189
</element>
 
190
 
 
191
<!-- argument Visibility: default -->
 
192
<element name="DebugMessageName.msgType">
 
193
<short>Message type</short>
 
194
</element>
 
195
 
 
196
</module> <!-- dbugmsg -->
 
197
 
 
198
</package>
 
199
</fpdoc-descriptions>