Commit d1b264b0 authored by Owen Fraser-Green's avatar Owen Fraser-Green
Browse files

Added mono documentation.

parent 375d665f
2004-05-15 Owen Fraser-Green <owen@discobabe.net>
* mono/Makefile.am: Added SUBDIR for docs
* mono/doc/*: Added documentation framework
* configure.in: Added monodoc check
* README: Added description of mono configure flags
2004-05-11 John (J5) Palmieri <johnp@redhat.com>:
* doc/dbus-specification.xml: Added a "Required" column to the
......
......@@ -13,6 +13,8 @@ the ./configure program.
--enable-qt enable Qt-friendly client library
--enable-glib enable GLib-friendly client library
--enable-mono enable mono bindings
--enable-mono-docs build mono documentation (requires monodoc)
--enable-tests enable unit test code
--enable-ansi enable -ansi -pedantic gcc flags
--enable-verbose-mode support verbose debug mode
......
......@@ -36,6 +36,7 @@ AC_ARG_ENABLE(gcov, [ --enable-gcov compile with coverage p
AC_ARG_ENABLE(abstract-sockets, [ --enable-abstract-sockets use abstract socket namespace (linux only)],enable_abstract_sockets=$enableval,enable_abstract_sockets=auto)
AC_ARG_ENABLE(gcj, [ --enable-gcj build gcj bindings],enable_gcj=$enableval,enable_gcj=no)
AC_ARG_ENABLE(mono, [ --enable-mono build mono bindings],enable_mono=$enableval,enable_mono=auto)
AC_ARG_ENABLE(mono_docs, [ --enable-mono-docs build mono docs],enable_mono_docs=$enableval,enable_mono_docs=auto)
AC_ARG_ENABLE(python, [ --enable-python build python bindings],enable_python=$enableval,enable_python=auto)
......@@ -211,6 +212,41 @@ fi
AM_CONDITIONAL(DBUS_USE_MCS, test x$enable_mono = xyes)
#### Look for monodoc
MONODOC_REQUIRED_VERSION=0.15
AC_SUBST(MONODOC_REQUIRED_VERSION)
PKG_CHECK_MODULES(MONODOC_DEPENDENCY, monodoc >= $MONODOC_REQUIRED_VERSION, have_monodoc=yes, have_monodoc=no)
if test x$enable_mono_docs = xyes; then
if test x$have_monodoc = xno ; then
AC_MSG_ERROR([Building Mono docs explicitly required, but monodoc not found])
else
AC_PATH_PROG(MONODOC, monodoc, no)
if test x$MONODOC = xno; then
AC_MSG_ERROR([Building Mono docs explicitly required, but monodoc not found])
fi
fi
fi
if test x$enable_mono_docs = xauto ; then
if test x$have_monodoc = xno ; then
enable_mono_docs=no
MONODOC=
else
AC_PATH_PROG(MONODOC, monodoc, no)
if test x$MONODOC = xno; then
enable_mono_docs=no
MONODOC=
else
enable_mono_docs=yes
fi
fi
fi
AC_SUBST(MONODOC)
AM_CONDITIONAL(ENABLE_MONODOC, test "x$enable_mono_docs" = "xyes")
changequote(,)dnl
# let ourselves use our own unstable API
CPPFLAGS="-DDBUS_API_SUBJECT_TO_CHANGE=1 $CPPFLAGS"
......@@ -1024,6 +1060,7 @@ gcj/org/freedesktop/Makefile
gcj/org/freedesktop/dbus/Makefile
mono/Makefile
mono/example/Makefile
mono/doc/Makefile
bus/Makefile
tools/Makefile
test/Makefile
......@@ -1094,6 +1131,7 @@ echo "
Building GLib bindings: ${have_glib}
Building Python bindings: ${have_python}
Building Mono bindings: ${enable_mono}
Building Mono docs: ${enable_mono_docs}
Building GTK+ tools: ${have_gtk}
Building X11 code: ${enable_x11}
Building Doxygen docs: ${enable_doxygen_docs}
......
.deps
.libs
Makefile
Makefile.in
*.lo
*.la
*.bb
*.bbg
*.gcov
*.da
.dbus-keyrings
*.dll
*.exe
test-dbus-sharp
if ENABLE_MONODOC
TARGETS = dbus-sharp-docs.zip dbus-sharp-docs.tree dbus-sharp-docs.source
DOCDIR = `$(MONODOC) --get-sourcesdir`
install-data-local:
install -m 644 $(srcdir)/dbus-sharp-docs.source `monodoc --get-sourcesdir`
install -m 644 $(srcdir)/dbus-sharp-docs.tree `monodoc --get-sourcesdir`
install -m 644 $(srcdir)/dbus-sharp-docs.zip `monodoc --get-sourcesdir`
else
TARGETS =
DOCDIR = $(datadir)
endif
noinst_DATA = $(TARGETS)
ASSEMBLER = $(MONODOC) --assemble
UPDATER = $(MONODOC) --update
dbus-sharp-docs.zip dbus-sharp-docs.tree: $(srcdir)/en/*/*.xml $(srcdir)/en/*.xml
$(ASSEMBLER) --ecma $(srcdir)/en -o dbus-sharp-docs
update:
$(UPDATER) ../dbus-sharp.dll -o ./en -f
CLEANFILES = dbus-sharp-docs.zip dbus-sharp-docs.tree
EXTRA_DIST = dbus-sharp-docs.source dbus-sharp-docs.tree dbus-sharp-docs.zip
dist-hook:
mkdir -p $(distdir)/en
cp $(srcdir)/en/*.xml $(distdir)/en/
mkdir -p $(distdir)/en/DBus
cp $(srcdir)/en/Dbus/*.xml $(distdir)/en/DBus.DBusType/
mkdir -p $(distdir)/en/DBus.DBusType
cp $(srcdir)/en/Dbus/*.xml $(distdir)/en/DBus.DBusType/
<?xml version="1.0"?>
<monodoc>
<source provider="ecma" basefile="dbus-sharp-docs" path="various" />
</monodoc>
<Namespace Name="DBus" FullName="DBus" FullNameSP="DBus" Maintainer="Mono">
<Docs>
<summary>Types for the D-BUS binding for .NET.</summary>
<remarks>
<para>
Types used by the D-BUS library.
</para>
</remarks>
</Docs>
</Namespace>
<Type Name="Array" FullName="DBus.DBusType.Array">
<TypeSignature Language="C#" Value="public class Array : IDBusType" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>dbus-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyCulture>neutral</AssemblyCulture>
<Attributes />
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>DBus.DBusType.IDBusType</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName="Code">
<MemberSignature Language="C#" Value="public static char Code;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Char</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Suits">
<MemberSignature Language="C#" Value="public static bool Suits (Type type);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="type" Type="System.Type" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="type">a <see cref="T:System.Type" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="EmitMarshalIn">
<MemberSignature Language="C#" Value="public static void EmitMarshalIn (System.Reflection.Emit.ILGenerator generator, Type type);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="generator" Type="System.Reflection.Emit.ILGenerator" />
<Parameter Name="type" Type="System.Type" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="generator">a <see cref="T:System.Reflection.Emit.ILGenerator" /></param>
<param name="type">a <see cref="T:System.Type" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="EmitMarshalOut">
<MemberSignature Language="C#" Value="public static void EmitMarshalOut (System.Reflection.Emit.ILGenerator generator, Type type, bool isReturn);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="generator" Type="System.Reflection.Emit.ILGenerator" />
<Parameter Name="type" Type="System.Type" />
<Parameter Name="isReturn" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="generator">a <see cref="T:System.Reflection.Emit.ILGenerator" /></param>
<param name="type">a <see cref="T:System.Type" /></param>
<param name="isReturn">a <see cref="T:System.Boolean" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Append">
<MemberSignature Language="C#" Value="public virtual void Append (IntPtr iter);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="iter" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">a <see cref="T:System.IntPtr" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Get">
<MemberSignature Language="C#" Value="public virtual object Get ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Object" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Get">
<MemberSignature Language="C#" Value="public virtual object Get (Type type);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="type" Type="System.Type" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="type">a <see cref="T:System.Type" /></param>
<returns>a <see cref="T:System.Object" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Array (Array val, DBus.Service service);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="val" Type="System.Array" />
<Parameter Name="service" Type="DBus.Service" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="val">a <see cref="T:System.Array" /></param>
<param name="service">a <see cref="T:DBus.Service" /></param>
<returns>a <see cref="T:DBus.DBusType.Array" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Array (IntPtr iter, DBus.Service service);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="iter" Type="System.IntPtr" />
<Parameter Name="service" Type="DBus.Service" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">a <see cref="T:System.IntPtr" /></param>
<param name="service">a <see cref="T:DBus.Service" /></param>
<returns>a <see cref="T:DBus.DBusType.Array" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>
\ No newline at end of file
<Type Name="Boolean" FullName="DBus.DBusType.Boolean">
<TypeSignature Language="C#" Value="public class Boolean : IDBusType" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>dbus-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyCulture>neutral</AssemblyCulture>
<Attributes />
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>DBus.DBusType.IDBusType</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName="Code">
<MemberSignature Language="C#" Value="public static char Code;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Char</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Suits">
<MemberSignature Language="C#" Value="public static bool Suits (Type type);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="type" Type="System.Type" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="type">a <see cref="T:System.Type" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="EmitMarshalIn">
<MemberSignature Language="C#" Value="public static void EmitMarshalIn (System.Reflection.Emit.ILGenerator generator, Type type);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="generator" Type="System.Reflection.Emit.ILGenerator" />
<Parameter Name="type" Type="System.Type" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="generator">a <see cref="T:System.Reflection.Emit.ILGenerator" /></param>
<param name="type">a <see cref="T:System.Type" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="EmitMarshalOut">
<MemberSignature Language="C#" Value="public static void EmitMarshalOut (System.Reflection.Emit.ILGenerator generator, Type type, bool isReturn);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="generator" Type="System.Reflection.Emit.ILGenerator" />
<Parameter Name="type" Type="System.Type" />
<Parameter Name="isReturn" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="generator">a <see cref="T:System.Reflection.Emit.ILGenerator" /></param>
<param name="type">a <see cref="T:System.Type" /></param>
<param name="isReturn">a <see cref="T:System.Boolean" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Append">
<MemberSignature Language="C#" Value="public virtual void Append (IntPtr iter);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="iter" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">a <see cref="T:System.IntPtr" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Get">
<MemberSignature Language="C#" Value="public virtual object Get ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Object" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Get">
<MemberSignature Language="C#" Value="public virtual object Get (Type type);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="type" Type="System.Type" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="type">a <see cref="T:System.Type" /></param>
<returns>a <see cref="T:System.Object" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Boolean (bool val, DBus.Service service);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="val" Type="System.Boolean" />
<Parameter Name="service" Type="DBus.Service" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="val">a <see cref="T:System.Boolean" /></param>
<param name="service">a <see cref="T:DBus.Service" /></param>
<returns>a <see cref="T:DBus.DBusType.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Boolean (IntPtr iter, DBus.Service service);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="iter" Type="System.IntPtr" />
<Parameter Name="service" Type="DBus.Service" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">a <see cref="T:System.IntPtr" /></param>
<param name="service">a <see cref="T:DBus.Service" /></param>
<returns>a <see cref="T:DBus.DBusType.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>
\ No newline at end of file
<Type Name="Byte" FullName="DBus.DBusType.Byte">
<TypeSignature Language="C#" Value="public class Byte : IDBusType" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>dbus-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyCulture>neutral</AssemblyCulture>
<Attributes />
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>DBus.DBusType.IDBusType</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName="Code">
<MemberSignature Language="C#" Value="public static char Code;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Char</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Suits">
<MemberSignature Language="C#" Value="public static bool Suits (Type type);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="type" Type="System.Type" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="type">a <see cref="T:System.Type" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="EmitMarshalIn">
<MemberSignature Language="C#" Value="public static void EmitMarshalIn (System.Reflection.Emit.ILGenerator generator, Type type);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="generator" Type="System.Reflection.Emit.ILGenerator" />
<Parameter Name="type" Type="System.Type" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="generator">a <see cref="T:System.Reflection.Emit.ILGenerator" /></param>
<param name="type">a <see cref="T:System.Type" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="EmitMarshalOut">
<MemberSignature Language="C#" Value="public static void EmitMarshalOut (System.Reflection.Emit.ILGenerator generator, Type type, bool isReturn);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="generator" Type="System.Reflection.Emit.ILGenerator" />
<Parameter Name="type" Type="System.Type" />
<Parameter Name="isReturn" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="generator">a <see cref="T:System.Reflection.Emit.ILGenerator" /></param>
<param name="type">a <see cref="T:System.Type" /></param>
<param name="isReturn">a <see cref="T:System.Boolean" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Append">
<MemberSignature Language="C#" Value="public virtual void Append (IntPtr iter);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="iter" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="iter">a <see cref="T:System.IntPtr" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Get">
<MemberSignature Language="C#" Value="public virtual object Get ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:System.Object" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Get">
<MemberSignature Language="C#" Value="public virtual object Get (Type type);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="type" Type="System.Type" />
</Parameters>