+ Fixed warnings, completed dateutils

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

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.

docs/dateutils.xml

@@ -8,7 +8,13 @@
 -->
 <module name="dateutils">
 <short>Date/Time manipulation routines.</short>
-<descr/>
+<descr>
+<file>DateUtils</file> contains a large number of date/time manipulation
+routines, all based on the <var>TDateTime</var> type. There are routines for
+date/time math, for comparing dates and times, for composing dates and
+decomposing dates in their constituent parts.
+</descr>
+
 <!-- unresolved type reference Visibility: default -->
 <element name="SysUtils">
 <short>Exception support</short>
@@ -5609,7 +5615,7 @@ when they have received invalid arguments.
 </p>
 </descr>
 <seealso>
-<link id="InvalidDateTime"/>
+<link id="InvalidDateTimeError"/>
 <link id="InvalidDateDayError"/>
 <link id="InvalidDateMonthWeekError"/>
 <link id="InvalidDayOfWeekInMonthError"/>

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}

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}

docs/rtl.xml

@@ -0,0 +1,51 @@
+<?xml version="1.0" encoding="ISO8859-1"?>
+<fpdoc-descriptions>
+<!--  
+
+   $Id$ 
+   This file is part of the FPC documentation. 
+   Copyright (C) 1997, by Michael Van Canneyt 
+ 
+   The FPC documentation is free text; you can redistribute it and/or 
+   modify it under the terms of the GNU Library General Public License as 
+   published by the Free Software Foundation; either version 2 of the 
+   License, or (at your option) any later version. 
+ 
+   The FPC Documentation is distributed in the hope that it will be useful, 
+   but WITHOUT ANY WARRANTY; without even the implied warranty of 
+   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU 
+   Library General Public License for more details. 
+ 
+   You should have received a copy of the GNU Library General Public 
+   License along with the FPC documentation; see the file COPYING.LIB.  If not, 
+   write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, 
+   Boston, MA 02111-1307, USA. 
+ -->
+<package name="rtl">
+<short>Free Pascal Run-Time Library</short>
+<descr>
+<p>
+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).
+</p>
+<p>
+There are units for compatibility with the Turbo Pascal Run-Time 
+library, and there are units for compatibility with Delphi.
+</p>
+<p>
+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.
+</p>
+<p>
+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. 
+</p> 
+<p>
+Units that fall outside the above outline do not belong in the RTL, but
+should be included in the packages, or in the FCL. 
+</p>
+</descr>
+</package>
+</fpdoc-descriptions>

docs/system.xml

@@ -569,8 +569,6 @@ Functions concerning memory issues.
 <tr><td><link id="High"/></td><td>Return highest index of open array or enumerated</td></tr>
 <tr><td><link id="IsMemoryManagerSet"/></td><td>Is the memory manager set</td></tr>
 <tr><td><link id="Low"/></td><td>Return lowest index of open array or enumerated</td></tr>
-<tr><td><link id="Maxavail"/></td><td>Return size of largest free memory block</td></tr>
-<tr><td><link id="Memavail"/></td><td>Return total available memory</td></tr>
 <tr><td><link id="Move"/></td><td>Move data from one location in memory to another</td></tr>
 <tr><td><link id="MoveChar0">MoveChar0</link></td><td>Move data till first zero character</td></tr>
 <tr><td><link id="New"/></td><td>Dynamically allocate memory for variable</td></tr>
@@ -2392,8 +2390,6 @@ If not enough memory is available, <var>Nil</var> will be returned.
 <link id="Dispose"/>
 <link id="Freemem"/>
 <link id="Getmem"/>
-<link id="Memavail"/>,
-<link id="Maxavail"/>
 </seealso>
 </element>