From e6ed2691ad6fee5a6f9fb239a9173e4beb517659 Mon Sep 17 00:00:00 2001 From: michael Date: Thu, 30 Dec 2004 13:48:53 +0000 Subject: [PATCH] + Fixed warnings, completed dateutils --- docs/Makefile | 12 +++++++---- docs/README.DOCS | 35 +++++++++++++++---------------- docs/dateutils.xml | 10 +++++++-- docs/fpc.sty | 2 ++ docs/rtl.tex | 1 + docs/rtl.xml | 51 ++++++++++++++++++++++++++++++++++++++++++++++ docs/system.xml | 4 ---- 7 files changed, 86 insertions(+), 29 deletions(-) create mode 100644 docs/rtl.xml diff --git a/docs/Makefile b/docs/Makefile index 03eb8dc767..9ffe6c61ed 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -67,7 +67,8 @@ endif # Which docs are made when 'html' is specified -HTML = user rtl fcl ref prog fpdoc chart +# fcl removed, should be added later on. +HTML = user rtl ref prog fpdoc chart # Can be 'report','book', 'html', 'hevea', 'ts3' 'ts4' ifdef USEHEVEA @@ -374,13 +375,13 @@ FCLOPTS=--package=fcl --descr=classes.xml --input='$(FPCSRCDIR)/rtl/$(HOSTOS)/cl fcl.inc: classes.xml $(FPDOC) --output=fcl.inc $(FCLOPTS) --format=latex -RTLOPTS=--package=rtl +RTLOPTS=--package=rtl --descr=rtl.xml ifndef CURRENTXMLONLY XMLUNITS=sysutils strutils dateutils systhrds strings mouse keyboard \ crt video dos sockets objects heaptrc mmx ipc printer typinfo \ ports getopts emu387 dxeload go32 gpm graph oldlinux baseunix \ unixtype unix classes unixutil x86 dynlibs linux math system\ - objpas dateutils + objpas dateutils rtl RTLXML=$(addsuffix .xml,$(XMLUNITS)) RTLOPTS+= --descr=strutils.xml --input="../rtl/objpas/strutils.pp" RTLOPTS+= --descr=systhrds.xml --input="../rtl/unix/systhrds.pp -Fi../rtl/inc" @@ -677,7 +678,10 @@ execute: # # $Log$ -# Revision 1.37 2004-12-22 08:47:31 marco +# Revision 1.38 2004-12-30 13:48:53 michael +# + Fixed warnings, completed dateutils +# +# Revision 1.37 2004/12/22 08:47:31 marco # * bsd system unit location fix. Hope it works for Darwin too # # Revision 1.36 2004/12/21 22:58:24 michael diff --git a/docs/README.DOCS b/docs/README.DOCS index 179efcf40a..ad9ef84192 100644 --- a/docs/README.DOCS +++ b/docs/README.DOCS @@ -1,6 +1,6 @@ This is the README for the Free Pascal documentation. -All documentation is stored here, in LaTeX format. +All documentation is stored here, in LaTeX format and in fpdoc format. it uses special style files (fpc*.sty) which are also in the directory. do a 'make dvi' to produce the dvi format of the docs. @@ -27,28 +27,25 @@ Why LaTeX ? In order to translate the things to HTML, I use latex2html, since it is the most powerful and flexible, although sluggish... -For it to be able to use the fpc.sty, I had to write a fpc.perl script -which it loads. The script seems to run fine when used standalone, but in -conjunction with latex2html, I get a out of memory... ?? -I'm not familiar with perl, so if someone is, and can fix the thing, please -do. (and let me know :) ) + +Why fpdoc ? +- Because it always creates up-to-date documentation. +- The documentation is separate from the units contrary to many other + documentation tools which require comments in the sources, which makes + the source unreadable. +- It's written in FPC. + + Then how to proceed ? -If you just want to write latex docs, just use fpc.sty. (you don't need -html.sty) -If you want to be able to convert to html, (you need html.sty) the following -fixes the perl-problem : -In the preamble of your document, type : - -\usepackage{html} -\latex{\usepackage{fpc}} -\html{\input{fpc-html.tex}} - -The fpc-html.tex defines the same commands as fpc.sty, only in a language -that latex2html understands. - +If you just want to write general latex docs, just use fpc.sty. fpc.sty.doc describes what fpc.sty does. (one day I'll integrate them using the doc package, but I need some time for it) +If you want to document units, use fpdoc. It is documented fairly complete, +and you can have a look at the many .xml units for examples on how to use +it. + Happy TeXing, + Michael. \ No newline at end of file diff --git a/docs/dateutils.xml b/docs/dateutils.xml index 1e64859703..ad876b5721 100644 --- a/docs/dateutils.xml +++ b/docs/dateutils.xml @@ -8,7 +8,13 @@ --> Date/Time manipulation routines. - + +DateUtils contains a large number of date/time manipulation +routines, all based on the TDateTime type. There are routines for +date/time math, for comparing dates and times, for composing dates and +decomposing dates in their constituent parts. + + Exception support @@ -5609,7 +5615,7 @@ when they have received invalid arguments.

- + diff --git a/docs/fpc.sty b/docs/fpc.sty index 9510646578..d19afb9e6b 100644 --- a/docs/fpc.sty +++ b/docs/fpc.sty @@ -163,6 +163,7 @@ % Useful references. % \newcommand{\progref}{\htmladdnormallink{Programmers guide}{../prog/prog.html}\xspace} +\newcommand{\fpdocref}{\htmladdnormallink{FPDoc reference guide}{../fpdoc/fpfoc.html}\xspace} \newcommand{\refref}{\htmladdnormallink{Reference guide}{../ref/ref.html}\xspace} \newcommand{\userref}{\htmladdnormallink{Users guide}{../user/user.html}\xspace} \newcommand{\unitsref}{\htmladdnormallink{Unit reference}{../units/units.html}\xspace} @@ -195,6 +196,7 @@ \newcommand{\atari}{\textsc{Atari}\xspace} \newcommand{\amiga}{\textsc{Amiga}\xspace} \newcommand{\solaris}{\textsc{Solaris}\xspace} +\newcommand{\netware}{\textsc{Netware}\xspace} \newcommand{\qnx}{\textsc{QNX Realtime platform}\xspace} \newcommand{\beos}{\textsc{BeOS}\xspace} \newcommand{\palmos}{\textsc{PalmOS}\xspace} diff --git a/docs/rtl.tex b/docs/rtl.tex index 46e5c36619..1c54a39c1d 100644 --- a/docs/rtl.tex +++ b/docs/rtl.tex @@ -38,6 +38,7 @@ % \begin{document} \title{Run-Time Library (RTL) : \\ Reference guide.} +\label{rtl} \docdescription{Reference guide for RTL units.} \docversion{1.9} \input{date.inc} diff --git a/docs/rtl.xml b/docs/rtl.xml new file mode 100644 index 0000000000..731806f38a --- /dev/null +++ b/docs/rtl.xml @@ -0,0 +1,51 @@ + + + + +Free Pascal Run-Time Library + +

+The Run-Time Library is the basis of all Free Pascal programs. +It contains the basic units that most programs will use, and are made +available on all platforms supported by Free pascal (well, more or less). +

+

+There are units for compatibility with the Turbo Pascal Run-Time +library, and there are units for compatibility with Delphi. +

+

+On top of these two sets, there are also a series of units to handle +keyboard/mouse and text screens in a cross-platform way. +

+

+Other units include platform specific units that implement the specifics +of a platform, these are usually needed to support the Turbo Pascal or +Delphi units. +

+

+Units that fall outside the above outline do not belong in the RTL, but +should be included in the packages, or in the FCL. +

+ + + \ No newline at end of file diff --git a/docs/system.xml b/docs/system.xml index 3f105a4f30..0d31870383 100644 --- a/docs/system.xml +++ b/docs/system.xml @@ -569,8 +569,6 @@ Functions concerning memory issues. Return highest index of open array or enumerated Is the memory manager set Return lowest index of open array or enumerated -Return size of largest free memory block -Return total available memory Move data from one location in memory to another MoveChar0Move data till first zero character Dynamically allocate memory for variable @@ -2392,8 +2390,6 @@ If not enough memory is available, Nil will be returned. -, -