+ Last changes to RTL documentation

docs/Makefile

@@ -1,8 +1,8 @@
 #
-# Don't edit, this file is generated by FPCMake Version 2.0.0 [2005/05/05]
+# Don't edit, this file is generated by FPCMake Version 1.9.8 [2005/04/10]
 #
 default: help
-MAKEFILETARGETS=i386-linux i386-go32v2 i386-win32 i386-os2 i386-freebsd i386-beos i386-netbsd i386-solaris i386-qnx i386-netware i386-openbsd i386-wdosx i386-emx i386-watcom i386-netwlibc m68k-linux m68k-freebsd m68k-netbsd m68k-amiga m68k-atari m68k-openbsd m68k-palmos powerpc-linux powerpc-netbsd powerpc-macos powerpc-darwin powerpc-morphos sparc-linux sparc-netbsd sparc-solaris x86_64-linux x86_64-freebsd arm-linux
+MAKEFILETARGETS=i386-linux
 BSDs = freebsd netbsd openbsd darwin
 UNIXs = linux $(BSDs) solaris qnx
 LIMIT83fs = go32v2 os2 emx watcom
@@ -1583,7 +1583,7 @@ endif
 FCLOPTS=--package=fcl --descr=classes.xml --input='$(FPCSRCDIR)/rtl/$(OS_SOURCE)/classes.pp -Fi$(FPCSRCDIR)/rtl/objpas/classes'
 fcl.inc: classes.xml
 	$(FPDOC) --output=fcl.inc $(FCLOPTS) --format=latex
-RTLOPTS=--package=rtl --descr=rtl.xml
+RTLOPTS=--hide-protected --warn-no-node --package=rtl --descr=rtl.xml
 ifndef CURRENTXMLONLY
 XMLUNITS=sysutils strutils dateutils strings mouse keyboard \
 	 crt video dos sockets objects heaptrc mmx ipc printer typinfo \

docs/Makefile.fpc

@@ -264,7 +264,7 @@ FCLOPTS=--package=fcl --descr=classes.xml --input='$(FPCSRCDIR)/rtl/$(OS_SOURCE)
 fcl.inc: classes.xml
         $(FPDOC) --output=fcl.inc $(FCLOPTS) --format=latex
 
-RTLOPTS=--package=rtl --descr=rtl.xml
+RTLOPTS=--hide-protected --warn-no-node --package=rtl --descr=rtl.xml
 ifndef CURRENTXMLONLY
 XMLUNITS=sysutils strutils dateutils strings mouse keyboard \
          crt video dos sockets objects heaptrc mmx ipc printer typinfo \
@@ -574,7 +574,10 @@ execute:
 
 #
 # $Log$
-# Revision 1.12  2005-05-05 12:59:59  peter
+# Revision 1.13  2005-05-07 09:41:09  michael
+# + Last changes to RTL documentation
+#
+# Revision 1.12  2005/05/05 12:59:59  peter
 #   * 2.0.0
 #
 # Revision 1.11  2005/02/20 00:38:28  michael

docs/baseunix.xml

@@ -4795,6 +4795,36 @@ It is simply a wrapper to the kernel system call.
 </seealso>
 </element>
 
+<element name="cDouble">
+<short>Double precision real format.</short>
+</element>
+
+
+<element name="cFloat">
+<short>Floating-point real format </short>
+</element>
+
+
+<element name="clDouble">
+<short>Long double precision real format (Extended)</short>
+</element>
+
+
+<element name="pcDouble">
+<short>Pointer to <link id="#rtl.baseunix.cdouble">cdouble</link> type.</short>
+</element>
+
+
+<element name="pcFloat">
+<short>Pointer to <link id="#rtl.baseunix.cfloat">cfloat</link> type.</short>
+</element>
+
+
+<element name="pclDouble">
+<short>Pointer to <link id="#rtl.baseunix.cldouble">cldouble</link> type.</short>
+</element>
+
+
 </module> <!-- BaseUnix -->
 </package>
 </fpdoc-descriptions>

docs/system.xml

@@ -7925,6 +7925,12 @@ milliseconds have elapsed.
 </descr>
 </element>
 
+<element name="ThreadingAlreadyUsed">
+<short>Internal constant for the threading system. Don't use.</short>
+</element>
+
+
+
 <!-- constant Visibility: default -->
 <element name="CtrlZMarksEOF">
 <short>Determine whether CTRL-Z marks the end of file.</short>
@@ -7944,6 +7950,8 @@ To get DOS-compatible behaviour, this constant can be set to <var>True</var>
 </seealso>
 </element>
 
+<element name="SIGSTKSZ" skip="1"/>
+
 </module>
 </package>
 </fpdoc-descriptions>

docs/sysutils.xml

@@ -2756,11 +2756,10 @@ errors are:
 <element name="FormatBuf">
 <short>Format a string with given arguments and store the result in a buffer.</short>
 <descr>
-<var>FormatBuf</var> calls formatfloat with <var>Buf</var>.
+<var>FormatBuf</var> calls <link id="Format"/> and stores the result in <var>Buf</var>.
 </descr>
-<errors>
-</errors>
 <seealso>
+<link id="Format"/>
 </seealso>
 <example file="sysutex/ex72"/>
 </element>
@@ -7474,6 +7473,74 @@ in <var>Line</var>. It breaks the string only at characters which are in
 </seealso>
 </element>
 
+<element name="FormatCurr">
+<short>Format a currency</short>
+<descr>
+<p>
+<var>FormatCurr</var> formats the currency <var>Value</var> according to the
+formatting rule in <var>Format</var>, and returns the resulting string.
+</p>
+<p>
+For an explanation of the formatting characters, see <link
+id="FormatFloat"/>.
+</p>
+</descr>
+<seealso>
+<link id="FormatFloat"/>
+<link id="FloatToText"/>
+</seealso>
+</element>
+
+
+<element name="TryStrToCurr">
+<short>Try to convert a string to a currency</short>
+<descr>
+<p>
+<var>TryStrToCurr</var> converts the string <var>S</var> to a currency value
+and returns the value in <var>Value</var>. The function returns
+<var>True</var> if it was successful, <var>False</var> if not. This is 
+contrary to <link id="StrToCurr"/>, which raises an exception when the 
+conversion fails.
+</p>
+<p>
+The function takes into account locale information.
+</p>
+</descr>
+<seealso>
+<link id="StrToCurr"/>
+<link id="TextToFloat"/>
+</seealso>
+</element>
+
+
+<element name="WideFmtStr">
+<short>Widestring format</short>
+<descr>
+<var>WideFmtStr</var> formats <var>Args</var> according to the format string
+in <var>Fmt</var> and returns the resulting string in <var>Res</var>.
+</descr>
+<seealso>
+<link id="WideFormat"/>
+<link id="WideFormatBuf"/>
+<link id="Format"/>
+</seealso>
+</element>
+
+<element name="WideFormatBuf">
+<short>Format widestring in a buffer.</short>
+<descr>
+<var>WideFormatBuf</var> calls simply <link id="WideFormat"/> with
+<var>Fmt</var> (with length <var>FmtLen</var> bytes) and stores maximum 
+<var>BufLen</var> bytes in the buffer <var>buf</var>. It returns the number
+of copied bytes.
+</descr>
+<seealso>
+<link id="WideFmtStr"/>
+<link id="WideFormat"/>
+<link id="Format"/>
+<link id="FormatBuf"/>
+</seealso>
+</element>
 
 </module>
 </package>

docs/typinfo.xml

@@ -1534,6 +1534,86 @@ information. If a wrong name is given for an enumerated value, then an
 </seealso>
 </element>
 
+<element name="OnGetPropValue">
+<short>Callback to get a property value as a variant.</short>
+<descr>
+This callback is set by the variants unit to enable reading of properties as
+a variant. If set, it is called by the <link id="GetPropValue"/> function.
+</descr>
+</element>
+
+
+<element name="OnGetVariantprop">
+<short>Callback to get a variant property value.</short>
+<descr>
+This callback is set by the variants unit to enable reading of variant properties
+If set, it is called by the <link id="GetVariantProp"/> function.
+</descr>
+</element>
+
+
+<element name="OnSetPropValue">
+<short>Callback to set a property value as a variant.</short>
+<descr>
+This callback is set by the variants unit to enable writing of properties as
+a variant. If set, it is called by the <link id="SetPropValue"/> function.
+</descr>
+</element>
+
+
+<element name="OnSetVariantprop">
+<short>Callback to set a variant property value.</short>
+<descr>
+This callback is set by the variants unit to enable writing of variant
+properties. If set, it is called by the <link id="GetVariantProp"/> function.
+</descr>
+</element>
+
+
+<element name="TGetPropValue">
+<short>Callback type for the <link id="#rtl.TypInfo.OnGetPropValue">OnGetPropValue</link> callback
+event</short>.
+<descr>
+The callback function must return the property with name <var>PropName</var>
+of instance <var>Instance</var>. If <var>PreferStrings</var> is true, it
+should favour converting the property to a string value. The function needs
+to return the variant with the property value.
+</descr>
+</element>
+
+
+
+<element name="TGetVariantProp">
+<short>Callback type for the <link id="#rtl.TypInfo.OnGetVariantProp">OnGetVariantProp</link> callback
+event</short>.
+<descr>
+The callback function must return the variant property with name <var>PropName</var>
+of instance <var>Instance</var>.
+</descr>
+</element>
+
+
+<element name="TSetPropValue">
+<short>Callback type for the <link id="#rtl.TypInfo.OnSetPropValue">OnSetPropValue</link> callback
+event</short>.
+<descr>
+The callback function must set the property with name <var>PropName</var>
+of instance <var>Instance</var> to <var>Value</var>.
+</descr>
+</element>
+
+
+<element name="TSetVariantProp">
+<short>Callback type for the <link id="#rtl.TypInfo.OnSetVariantProp">OnSetVariantProp</link> callback
+event</short>.
+<descr>
+The callback function must set the variant property with name <var>PropName</var>
+of instance to <var>Value</var>.
+</descr>
+</element>
+
+
+
 </module>
 </package>
 </fpdoc-descriptions>

docs/unix.xml

@@ -2517,6 +2517,39 @@ function.
 <short>Pad bytes. Do not use.</short>
 </element>
 
+<element name="cDouble">
+<short>Double precision real format.</short>
+</element>
+
+
+<element name="cFloat">
+<short>Floating-point real format </short>
+</element>
+
+
+<element name="clDouble">
+<short>Long double precision real format (Extended)</short>
+</element>
+
+
+<element name="pcDouble">
+<short>Pointer to <link id="#rtl.baseunix.cdouble">cdouble</link> type.</short>
+</element>
+
+
+<element name="pcFloat">
+<short>Pointer to <link id="#rtl.baseunix.cfloat">cfloat</link> type.</short>
+</element>
+
+
+<element name="pclDouble">
+<short>Pointer to <link id="#rtl.baseunix.cldouble">cldouble</link> type.</short>
+</element>
+
+<element name="tzseconds">
+<short>Timezone offset in seconds</short>
+</element>
+
 </module> <!-- Unix -->
 </package>
 </fpdoc-descriptions>

docs/unixtype.xml

@@ -827,6 +827,53 @@ anytime.
 <short><link id="#rtl.unix.fpGetPriority"/> option: Get user priority.</short>
 </element>
 
+<element name="cDouble">
+<short>Double precision real format.</short>
+</element>
+
+
+<element name="cFloat">
+<short>Floating-point real format </short>
+</element>
+
+
+<element name="clDouble">
+<short>Long double precision real format (Extended)</short>
+</element>
+
+
+<element name="pcDouble">
+<short>Pointer to <link id="#rtl.unixtype.cdouble">cdouble</link> type.</short>
+</element>
+
+
+<element name="pcFloat">
+<short>Pointer to <link id="#rtl.unixtype.cfloat">cfloat</link> type.</short>
+</element>
+
+
+<element name="pclDouble">
+<short>Pointer to <link id="#rtl.unixtype.cldouble">cldouble</link> type.</short>
+</element>
+
+<element name="psize_t">
+<short>Pointer to <link id="rtl.unixtype.size_t">size_t</link> type.</short>
+</element>
+
+
+<element name="pwchar_t">
+<short>Pointer to <link id="rtl.unixtype.wchar_t">wchar_t</link> type.</short>
+</element>
+
+
+<element name="wchar_t">
+<short>Wide character type.</short>
+</element>
+
+
+<element name="wint_t">
+<short>Wide character size type.</short>
+</element>
 
 </module> <!-- unixtype -->
 </package>