From 966f69e8f98e3e02f9f29cc93b85617913342156 Mon Sep 17 00:00:00 2001
From: Merlijn Wajer <merlijn@wajer.org>
Date: Sat, 4 Sep 2010 15:28:04 +0200
Subject: [PATCH] Makefile for FPDoc + more documentation

---
 LazDoc/Makefile          | 16 ++++++++++++++++
 LazDoc/dtm.xml           | 13 +++++++++++++
 LazDoc/mufasatypes.xml   | 40 ++++++++++++++++++++++++++++++++++++++++
 LazDoc/os_linux.xml      | 32 +++++++++++++++++++++++++++++++-
 LazDoc/simbasettings.xml |  6 ++++++
 5 files changed, 106 insertions(+), 1 deletion(-)
 create mode 100644 LazDoc/Makefile
 create mode 100644 LazDoc/dtm.xml
 create mode 100644 LazDoc/mufasatypes.xml
 create mode 100644 LazDoc/simbasettings.xml

diff --git a/LazDoc/Makefile b/LazDoc/Makefile
new file mode 100644
index 0000000..942fc0a
--- /dev/null
+++ b/LazDoc/Makefile
@@ -0,0 +1,16 @@
+
+.PHONY:	default clean
+
+docunits := os_linux dtm mufasatypes
+coreunits := os_linux dtm mufasatypes
+
+default:
+	
+	fpdoc --package=Simba \
+		`echo $(docunits) | sed -r 's/\w+/--descr=&.xml/g'` \
+		`echo $(coreunits) | sed -r 's/\w+/--input=..\/Units\/MMLCore\/&.pas/g'` \
+		--output=simbafpcdoc/
+
+
+clean:
+	rm -rf simbafpcdoc
diff --git a/LazDoc/dtm.xml b/LazDoc/dtm.xml
new file mode 100644
index 0000000..8056879
--- /dev/null
+++ b/LazDoc/dtm.xml
@@ -0,0 +1,13 @@
+<?xml version="1.0"?>
+<fpdoc-descriptions>
+  <package name="Simba">
+    <module name="dtm">
+      <element name="TMDTM">
+        <short>DTM Class</short>
+      </element>
+      <element name="TMDTM.Valid">
+        <short>Returns true if the DTM is valid.</short>
+      </element>
+    </module>
+  </package>
+</fpdoc-descriptions>
diff --git a/LazDoc/mufasatypes.xml b/LazDoc/mufasatypes.xml
new file mode 100644
index 0000000..0b68aa3
--- /dev/null
+++ b/LazDoc/mufasatypes.xml
@@ -0,0 +1,40 @@
+<?xml version="1.0"?>
+<fpdoc-descriptions>
+  <package name="Simba">
+    <module name="MufasaTypes">
+      <element name="TRetData">
+        <short>Structure containing pixel data pointer and information about the pointer</short>
+      </element>
+      <element name="DS">
+        <short>The directory seperator constant</short>
+      </element>
+      <element name="TMousePress">
+        <short>Mouse press enum</short>
+      </element>
+      <element name="TMousePress.mouse_Down">
+        <short>Mouse down</short>
+      </element>
+      <element name="TMousePress.mouse_Up">
+        <short>Mouse up</short>
+      </element>
+      <element name="TTargetWindowMode">
+        <short>Target Window Mode</short>
+      </element>
+      <element name="TTargetWindowMode.w_BMP">
+        <short>Bitmap Window Mode</short>
+      </element>
+      <element name="TTargetWindowMode.w_Window">
+        <short>MS Windows Window Mode</short>
+      </element>
+      <element name="TTargetWindowMode.w_HDC">
+        <short>HDC Window Mode</short>
+      </element>
+      <element name="TTargetWindowMode.w_ArrayPtr">
+        <short>Raw Data Window Mode</short>
+      </element>
+      <element name="TTargetWindowMode.w_XWindow">
+        <short>X11 Window Mode</short>
+      </element>
+    </module>
+  </package>
+</fpdoc-descriptions>
diff --git a/LazDoc/os_linux.xml b/LazDoc/os_linux.xml
index 02d737a..f287d9e 100644
--- a/LazDoc/os_linux.xml
+++ b/LazDoc/os_linux.xml
@@ -59,7 +59,7 @@
       </element>
       <element name="MufasaXErrorHandler">
         <short>X Error Handler.</short>
-        <descr>    This is extremely hacky, but also very useful.
+        <descr>This is extremely hacky, but also very useful.
     We have to install a X error handler, because otherwise X
     will terminate out entire app on error.
 
@@ -81,6 +81,36 @@
       <element name="TWindow.GetNativeWindow">
         <short>Returns the stored TWindow</short>
       </element>
+      <element name="TWindow.display">
+        <short>X11 display connection</short>
+      </element>
+      <element name="TWindow.window">
+        <short>Currently selected TWindow</short>
+      </element>
+      <element name="TWindow.buffer">
+        <short>XImage buffer</short>
+      </element>
+      <element name="TWindow.dirty">
+        <short>Used to determine wether we still have an image loaded or not.</short>
+      </element>
+      <element name="TWindow.keyinput">
+        <short>keyinput class from Lazarus</short>
+      </element>
+      <element name="TWindow.oldXHandler">
+        <short>The old X error handler</short>
+      </element>
+      <element name="TIOManager.display">
+        <short>X Display Connection</short>
+      </element>
+      <element name="TIOManager.desktop">
+        <short>Desktop TWindow</short>
+      </element>
+      <element name="ErrorCS">
+        <short>Critical Section used to handle X errors in a pretty way.</short>
+      </element>
+      <element name="xerror">
+        <short>xerror contains the last known X error that hasn't been handled.</short>
+      </element>
     </module>
   </package>
 </fpdoc-descriptions>
diff --git a/LazDoc/simbasettings.xml b/LazDoc/simbasettings.xml
new file mode 100644
index 0000000..f7ef0d7
--- /dev/null
+++ b/LazDoc/simbasettings.xml
@@ -0,0 +1,6 @@
+<?xml version="1.0"?>
+<fpdoc-descriptions>
+  <package name="Simba">
+    <module name="Simbasettings"/>
+  </package>
+</fpdoc-descriptions>