moparisthebest/Simba
1
0
Fork 0
mirror of https://github.com/moparisthebest/Simba synced 2024-11-24 10:12:20 -05:00
Code Issues Releases Wiki Activity

Makefile for FPDoc + more documentation

Browse Source
This commit is contained in:
Merlijn Wajer 2010-09-04 15:28:04 +02:00
parent 853b5227d0
commit 966f69e8f9
5 changed files with 106 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
LazDoc/Makefile Normal file
View File

@ -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

13
LazDoc/dtm.xml Normal file
View File

@ -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>

40
LazDoc/mufasatypes.xml Normal file
View File

@ -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>

32
LazDoc/os_linux.xml
View File

@ -59,7 +59,7 @@
</element> </element>
<element name="MufasaXErrorHandler"> <element name="MufasaXErrorHandler">
<short>X Error Handler.</short> <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 We have to install a X error handler, because otherwise X
will terminate out entire app on error. will terminate out entire app on error.
@ -81,6 +81,36 @@
<element name="TWindow.GetNativeWindow"> <element name="TWindow.GetNativeWindow">
<short>Returns the stored TWindow</short> <short>Returns the stored TWindow</short>
</element> </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> </module>
</package> </package>
</fpdoc-descriptions> </fpdoc-descriptions>

6
LazDoc/simbasettings.xml Normal file
View File

@ -0,0 +1,6 @@
<?xml version="1.0"?>
<fpdoc-descriptions>
<package name="Simba">
<module name="Simbasettings"/>
</package>
</fpdoc-descriptions>