diff --git a/ChangeLog b/ChangeLog index a30294b..33e9339 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,15 @@ +2006-01-13 Eric Butler + + * configure.ac: Generate makefile in doc directory, check for monodoc + * Makefile.am: Compile doc directory + * doc/en/*: Added initial english docs + * doc/hal-sharp-docs.source: New file for docs + * doc/Makefile.am: New filee dor docs + +2006-01-13 Aaron Bockover + + * Makefile.am: Changed DISTCLEANFILES to MAINTAINERCLEANFILES + 2006-01-13 Aaron Bockover * src/hal-sharp.dll.config.in: This was missing, how cute diff --git a/Makefile.am b/Makefile.am index 0f620ed..64ff14a 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,9 +1,9 @@ -SUBDIRS = src +SUBDIRS = src doc EXTRA_DIST = hal-sharp.pc.in hal-sharp.mds hal-sharp.mdp pkgconfigdir = $(libdir)/pkgconfig pkgconfig_DATA = hal-sharp.pc -DISTCLEANFILES = config.* configure INSTALL install-sh missing aclocal.m4 Makefile.in *.pidb +MAINTAINERCLEANFILES = config.* configure INSTALL install-sh missing aclocal.m4 Makefile.in *.pidb diff --git a/configure.ac b/configure.ac index d8959e6..5fa947d 100644 --- a/configure.ac +++ b/configure.ac @@ -28,6 +28,21 @@ if test "x$MONO" = "xno"; then AC_MSG_ERROR([You need to install the Mono runtime]) fi +dnl monodoc +AC_PATH_PROG(MDASSEMBLER, mdassembler, no) +AC_PATH_PROG(MONODOCER, monodocer, no) +if test "x$MONODOCER" = "xno" -o "x$MDASSEMBLER" = "xno"; then + enable_monodoc=no + doc_sources_dir= +else + enable_monodoc=yes + doc_sources_dir="`pkg-config --variable=sourcesdir monodoc`" +fi +AC_SUBST(MDASSEMBLER) +AC_SUBST(MONODOCER) +AM_CONDITIONAL(ENABLE_MONODOC, test "x$enable_monodoc" = "xyes") + + dnl Test for HAL PKG_CHECK_MODULES(HAL, dbus-1 \ @@ -41,7 +56,17 @@ AC_OUTPUT([ src/Makefile src/AssemblyInfo.cs src/hal-sharp.dll.config + doc/Makefile hal-sharp.pc ]) +echo " +hal-sharp-$VERSION + + Install Prefix: ${prefix} + Mono C# Compiler: ${MCS} + Mono Runtime: ${MONO} + + Documentation: ${enable_monodoc} +" diff --git a/doc/Makefile.am b/doc/Makefile.am new file mode 100644 index 0000000..220ab44 --- /dev/null +++ b/doc/Makefile.am @@ -0,0 +1,46 @@ +ASSEMBLIES = \ + hal-sharp.dll + +UPDATE_ASSEMBLIES = $(addprefix -assembly:lib/, $(ASSEMBLIES)) + +if ENABLE_MONODOC +SOURCESDIR=$(prefix)/lib/monodoc/sources +TARGETS=hal-sharp-docs.zip hal-sharp-docs.tree hal-sharp-docs.source +UPDATER = $(MONODOCER) -path:en $(UPDATE_ASSEMBLIES) +else +SOURCESDIR=$(datadir) +TARGETS= +UPDATER = echo "All optional assemblies must be built to use the updater." && exit 1 +endif + +monodocdir=$(SOURCESDIR) +monodoc_DATA=$(TARGETS) + +assemble: hal-sharp-docs.zip hal-sharp-docs.tree + +hal-sharp-docs.zip hal-sharp-docs.tree: $(srcdir)/en/*.xml $(srcdir)/en/*.xml + $(MDASSEMBLER) --ecma $(srcdir)/en -o hal-sharp-docs + +get-assemblies: + mkdir -p lib + cp $(top_builddir)/src/hal-sharp.dll lib + +update: get-assemblies + $(UPDATER) --delete + +CLEANFILES=hal-sharp-docs.zip hal-sharp-docs.tree +EXTRA_DIST=hal-sharp-docs.source +MAINTAINERCLEANFILES=Makefile.in + +NAMESPACES=Hal + +dist-hook: + mkdir -p $(distdir)/en + cp $(srcdir)/en/*.xml $(distdir)/en/ + for i in $(NAMESPACES); do \ + mkdir -p $(distdir)/en/$$i; \ + cp $(srcdir)/en/$$i/*.xml $(distdir)/en/$$i; \ + done + +clean-local: + rm -rf lib diff --git a/doc/en/Hal.xml b/doc/en/Hal.xml new file mode 100644 index 0000000..614d772 --- /dev/null +++ b/doc/en/Hal.xml @@ -0,0 +1,6 @@ + + + To be added. + To be added. + + diff --git a/doc/en/Hal/Context.xml b/doc/en/Hal/Context.xml new file mode 100644 index 0000000..2a89e9e --- /dev/null +++ b/doc/en/Hal/Context.xml @@ -0,0 +1,206 @@ + + + + hal-sharp + 0.3.0.0 + + + System.Object + + + + System.IDisposable + + + + + + Constructor + + + To be added. + To be added. + + + + + Constructor + + + + + To be added. + To be added. + To be added. + + + + + Constructor + + + + + To be added. + To be added. + To be added. + + + + + Constructor + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + Event + + Hal.DeviceAddedHandler + + + To be added. + To be added. + + + + + Event + + Hal.DeviceRemovedHandler + + + To be added. + To be added. + + + + + Event + + Hal.DeviceNewCapabilityHandler + + + To be added. + To be added. + + + + + Event + + Hal.DeviceLostCapabilityHandler + + + To be added. + To be added. + + + + + Event + + Hal.DevicePropertyModifiedHandler + + + To be added. + To be added. + + + + + Event + + Hal.DeviceConditionHandler + + + To be added. + To be added. + + + + + Method + + System.Void + + + + To be added. + To be added. + + + + + Method + + System.Void + + + + To be added. + To be added. + + + + + Method + + System.Void + + + + To be added. + To be added. + + + + + Property + + System.IntPtr + + + To be added. + To be added. + To be added. + + + + + Property + + System.Boolean + + + To be added. + To be added. + To be added. + + + + + Property + + System.Runtime.InteropServices.HandleRef + + + To be added. + To be added. + To be added. + + + + + To be added. + To be added. + + diff --git a/doc/en/Hal/DBusError.xml b/doc/en/Hal/DBusError.xml new file mode 100644 index 0000000..4c62235 --- /dev/null +++ b/doc/en/Hal/DBusError.xml @@ -0,0 +1,105 @@ + + + + hal-sharp + 0.3.0.0 + + + System.Object + + + + System.IDisposable + + + + + + Constructor + + + To be added. + To be added. + + + + + Method + + System.Void + + + + To be added. + To be added. + + + + + Method + + System.Void + + + + + + To be added. + To be added. + To be added. + + + + + Property + + System.Boolean + + + To be added. + To be added. + To be added. + + + + + Property + + System.String + + + To be added. + To be added. + To be added. + + + + + Property + + System.String + + + To be added. + To be added. + To be added. + + + + + Property + + System.IntPtr + + + To be added. + To be added. + To be added. + + + + + To be added. + To be added. + + diff --git a/doc/en/Hal/DbusBusType.xml b/doc/en/Hal/DbusBusType.xml new file mode 100644 index 0000000..c7be0cb --- /dev/null +++ b/doc/en/Hal/DbusBusType.xml @@ -0,0 +1,46 @@ + + + + hal-sharp + 0.3.0.0 + + + System.Enum + + + + + Field + + Hal.DbusBusType + + + To be added. + + + + + Field + + Hal.DbusBusType + + + To be added. + + + + + Field + + Hal.DbusBusType + + + To be added. + + + + + To be added. + To be added. + + diff --git a/doc/en/Hal/Device+FindBy.xml b/doc/en/Hal/Device+FindBy.xml new file mode 100644 index 0000000..07d75e2 --- /dev/null +++ b/doc/en/Hal/Device+FindBy.xml @@ -0,0 +1,46 @@ + + + + hal-sharp + 0.3.0.0 + + + System.Enum + + + + + Field + + Hal.Device+FindBy + + + To be added. + + + + + Field + + Hal.Device+FindBy + + + To be added. + + + + + Field + + Hal.Device+FindBy + + + To be added. + + + + + To be added. + To be added. + + diff --git a/doc/en/Hal/Device.xml b/doc/en/Hal/Device.xml new file mode 100644 index 0000000..e1d6eaf --- /dev/null +++ b/doc/en/Hal/Device.xml @@ -0,0 +1,668 @@ + + + + hal-sharp + 0.3.0.0 + + + System.Object + + + + + System.Reflection.DefaultMember(MemberName="Item") + + + + + + Constructor + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + Method + + System.Void + + + + To be added. + To be added. + + + + + Method + + System.Boolean + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + Method + + System.String[] + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + Method + + System.Boolean + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + Method + + System.Boolean + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + Method + + System.Boolean + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + Method + + System.Boolean + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + Method + + System.String + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + Method + + System.Boolean + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + Method + + System.Int32 + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + Method + + System.Boolean + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + Method + + System.UInt64 + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + Method + + System.Boolean + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + Method + + System.Double + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + Method + + System.Boolean + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + Method + + System.Boolean + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + Method + + System.Boolean + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + Method + + System.Boolean + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + Method + + System.Boolean + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + Method + + System.Void + + + + + + To be added. + To be added. + To be added. + + + + + Method + + System.Boolean + + + + To be added. + To be added. + To be added. + + + + + Method + + System.Boolean + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + Method + + System.Boolean + + + + To be added. + To be added. + To be added. + + + + + Method + + System.Boolean + + + + To be added. + To be added. + To be added. + + + + + Method + + System.Boolean + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + Method + + System.String[] + + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + Method + + Hal.Device[] + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + Method + + System.String[] + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + Method + + Hal.Device[] + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + Method + + System.String[] + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + Method + + Hal.Device[] + + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + Method + + System.String[] + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + Method + + Hal.Device[] + + + + + + + To be added. + To be added. + To be added. + To be added. + To be added. + + + + + Property + + System.Boolean + + + To be added. + To be added. + To be added. + + + + + Property + + Hal.Device + + + To be added. + To be added. + To be added. + + + + + Property + + Hal.Context + + + To be added. + To be added. + To be added. + + + + + Property + + System.String + + + To be added. + To be added. + To be added. + + + + + Property + + System.Boolean + + + To be added. + To be added. + To be added. + + + + + Property + + System.String + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + To be added. + To be added. + + diff --git a/doc/en/Hal/DeviceAddedArgs.xml b/doc/en/Hal/DeviceAddedArgs.xml new file mode 100644 index 0000000..0cb322c --- /dev/null +++ b/doc/en/Hal/DeviceAddedArgs.xml @@ -0,0 +1,37 @@ + + + + hal-sharp + 0.3.0.0 + + + System.EventArgs + + + + + + Constructor + + + To be added. + To be added. + + + + + Field + + Hal.Device + + + To be added. + To be added. + + + + + To be added. + To be added. + + diff --git a/doc/en/Hal/DeviceAddedHandler.xml b/doc/en/Hal/DeviceAddedHandler.xml new file mode 100644 index 0000000..a1a082c --- /dev/null +++ b/doc/en/Hal/DeviceAddedHandler.xml @@ -0,0 +1,23 @@ + + + + hal-sharp + 0.3.0.0 + + + System.Delegate + + + + + + + System.Void + + + To be added. + To be added. + To be added. + To be added. + + diff --git a/doc/en/Hal/DeviceConditionArgs.xml b/doc/en/Hal/DeviceConditionArgs.xml new file mode 100644 index 0000000..7dccf86 --- /dev/null +++ b/doc/en/Hal/DeviceConditionArgs.xml @@ -0,0 +1,59 @@ + + + + hal-sharp + 0.3.0.0 + + + System.EventArgs + + + + + + Constructor + + + To be added. + To be added. + + + + + Field + + Hal.Device + + + To be added. + To be added. + + + + + Field + + System.String + + + To be added. + To be added. + + + + + Field + + System.String + + + To be added. + To be added. + + + + + To be added. + To be added. + + diff --git a/doc/en/Hal/DeviceConditionHandler.xml b/doc/en/Hal/DeviceConditionHandler.xml new file mode 100644 index 0000000..f29ad64 --- /dev/null +++ b/doc/en/Hal/DeviceConditionHandler.xml @@ -0,0 +1,23 @@ + + + + hal-sharp + 0.3.0.0 + + + System.Delegate + + + + + + + System.Void + + + To be added. + To be added. + To be added. + To be added. + + diff --git a/doc/en/Hal/DeviceLostCapabilityArgs.xml b/doc/en/Hal/DeviceLostCapabilityArgs.xml new file mode 100644 index 0000000..c2edf4b --- /dev/null +++ b/doc/en/Hal/DeviceLostCapabilityArgs.xml @@ -0,0 +1,48 @@ + + + + hal-sharp + 0.3.0.0 + + + System.EventArgs + + + + + + Constructor + + + To be added. + To be added. + + + + + Field + + Hal.Device + + + To be added. + To be added. + + + + + Field + + System.String + + + To be added. + To be added. + + + + + To be added. + To be added. + + diff --git a/doc/en/Hal/DeviceLostCapabilityHandler.xml b/doc/en/Hal/DeviceLostCapabilityHandler.xml new file mode 100644 index 0000000..90d7d9d --- /dev/null +++ b/doc/en/Hal/DeviceLostCapabilityHandler.xml @@ -0,0 +1,23 @@ + + + + hal-sharp + 0.3.0.0 + + + System.Delegate + + + + + + + System.Void + + + To be added. + To be added. + To be added. + To be added. + + diff --git a/doc/en/Hal/DeviceNewCapabilityArgs.xml b/doc/en/Hal/DeviceNewCapabilityArgs.xml new file mode 100644 index 0000000..abd783b --- /dev/null +++ b/doc/en/Hal/DeviceNewCapabilityArgs.xml @@ -0,0 +1,48 @@ + + + + hal-sharp + 0.3.0.0 + + + System.EventArgs + + + + + + Constructor + + + To be added. + To be added. + + + + + Field + + Hal.Device + + + To be added. + To be added. + + + + + Field + + System.String + + + To be added. + To be added. + + + + + To be added. + To be added. + + diff --git a/doc/en/Hal/DeviceNewCapabilityHandler.xml b/doc/en/Hal/DeviceNewCapabilityHandler.xml new file mode 100644 index 0000000..058787c --- /dev/null +++ b/doc/en/Hal/DeviceNewCapabilityHandler.xml @@ -0,0 +1,23 @@ + + + + hal-sharp + 0.3.0.0 + + + System.Delegate + + + + + + + System.Void + + + To be added. + To be added. + To be added. + To be added. + + diff --git a/doc/en/Hal/DevicePropertyModifiedArgs.xml b/doc/en/Hal/DevicePropertyModifiedArgs.xml new file mode 100644 index 0000000..a1ff932 --- /dev/null +++ b/doc/en/Hal/DevicePropertyModifiedArgs.xml @@ -0,0 +1,70 @@ + + + + hal-sharp + 0.3.0.0 + + + System.EventArgs + + + + + + Constructor + + + To be added. + To be added. + + + + + Field + + Hal.Device + + + To be added. + To be added. + + + + + Field + + System.String + + + To be added. + To be added. + + + + + Field + + System.Boolean + + + To be added. + To be added. + + + + + Field + + System.Boolean + + + To be added. + To be added. + + + + + To be added. + To be added. + + diff --git a/doc/en/Hal/DevicePropertyModifiedHandler.xml b/doc/en/Hal/DevicePropertyModifiedHandler.xml new file mode 100644 index 0000000..3255df6 --- /dev/null +++ b/doc/en/Hal/DevicePropertyModifiedHandler.xml @@ -0,0 +1,23 @@ + + + + hal-sharp + 0.3.0.0 + + + System.Delegate + + + + + + + System.Void + + + To be added. + To be added. + To be added. + To be added. + + diff --git a/doc/en/Hal/DeviceRemovedArgs.xml b/doc/en/Hal/DeviceRemovedArgs.xml new file mode 100644 index 0000000..5ebaa86 --- /dev/null +++ b/doc/en/Hal/DeviceRemovedArgs.xml @@ -0,0 +1,37 @@ + + + + hal-sharp + 0.3.0.0 + + + System.EventArgs + + + + + + Constructor + + + To be added. + To be added. + + + + + Field + + Hal.Device + + + To be added. + To be added. + + + + + To be added. + To be added. + + diff --git a/doc/en/Hal/DeviceRemovedHandler.xml b/doc/en/Hal/DeviceRemovedHandler.xml new file mode 100644 index 0000000..8b123a3 --- /dev/null +++ b/doc/en/Hal/DeviceRemovedHandler.xml @@ -0,0 +1,23 @@ + + + + hal-sharp + 0.3.0.0 + + + System.Delegate + + + + + + + System.Void + + + To be added. + To be added. + To be added. + To be added. + + diff --git a/doc/en/Hal/HalException.xml b/doc/en/Hal/HalException.xml new file mode 100644 index 0000000..6ba95ef --- /dev/null +++ b/doc/en/Hal/HalException.xml @@ -0,0 +1,29 @@ + + + + hal-sharp + 0.3.0.0 + + + System.ApplicationException + + + + + + Constructor + + + + + To be added. + To be added. + To be added. + + + + + To be added. + To be added. + + diff --git a/doc/en/Hal/PropertyType.xml b/doc/en/Hal/PropertyType.xml new file mode 100644 index 0000000..fdb7657 --- /dev/null +++ b/doc/en/Hal/PropertyType.xml @@ -0,0 +1,86 @@ + + + + hal-sharp + 0.3.0.0 + + + System.Enum + + + + + Field + + Hal.PropertyType + + + To be added. + + + + + Field + + Hal.PropertyType + + + To be added. + + + + + Field + + Hal.PropertyType + + + To be added. + + + + + Field + + Hal.PropertyType + + + To be added. + + + + + Field + + Hal.PropertyType + + + To be added. + + + + + Field + + Hal.PropertyType + + + To be added. + + + + + Field + + Hal.PropertyType + + + To be added. + + + + + To be added. + To be added. + + diff --git a/doc/en/index.xml b/doc/en/index.xml new file mode 100644 index 0000000..9278601 --- /dev/null +++ b/doc/en/index.xml @@ -0,0 +1,46 @@ + + + + + + System.Reflection.AssemblyCompany(Company="Novell, Inc.") + + + System.Reflection.AssemblyCopyright(Copyright="Copyright (c) 2005 Novell, Inc.") + + + System.Reflection.AssemblyDescription(Description="HAL API Bindings") + + + System.Reflection.AssemblyTitle(Title="hal-sharp") + + + + + To be added. + To be added. + + + + + + + + + + + + + + + + + + + + + + + + hal-sharp + diff --git a/doc/hal-sharp-docs.source b/doc/hal-sharp-docs.source new file mode 100644 index 0000000..146d397 --- /dev/null +++ b/doc/hal-sharp-docs.source @@ -0,0 +1,4 @@ + + + +