diff options
author | Chow Loong Jin <hyperair@gmail.com> | 2009-08-02 04:10:21 +0800 |
---|---|---|
committer | Chow Loong Jin <hyperair@gmail.com> | 2009-08-02 04:10:28 +0800 |
commit | 055ad0e4149d9d552abc35c2880bf3ecbfe12e74 (patch) | |
tree | f2e6ebaa94554bf2c3cb83251e1ee75784724471 /docs |
Import upstream version 0.4.0~r3032
Diffstat (limited to 'docs')
-rw-r--r-- | docs/Makefile.am | 38 | ||||
-rw-r--r-- | docs/Makefile.in | 371 | ||||
-rw-r--r-- | docs/en/Notifications.xml | 6 | ||||
-rw-r--r-- | docs/en/Notifications/ActionArgs.xml | 29 | ||||
-rw-r--r-- | docs/en/Notifications/ActionHandler.xml | 23 | ||||
-rw-r--r-- | docs/en/Notifications/CloseArgs.xml | 29 | ||||
-rw-r--r-- | docs/en/Notifications/CloseHandler.xml | 23 | ||||
-rw-r--r-- | docs/en/Notifications/CloseReason.xml | 40 | ||||
-rw-r--r-- | docs/en/Notifications/Global.xml | 29 | ||||
-rw-r--r-- | docs/en/Notifications/Notification.xml | 164 | ||||
-rw-r--r-- | docs/en/Notifications/ServerInformation.xml | 41 | ||||
-rw-r--r-- | docs/en/Notifications/Urgency.xml | 34 | ||||
-rw-r--r-- | docs/en/index.xml | 36 | ||||
-rw-r--r-- | docs/notify-sharp-docs.source | 5 |
14 files changed, 868 insertions, 0 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am new file mode 100644 index 0000000..e43826e --- /dev/null +++ b/docs/Makefile.am @@ -0,0 +1,38 @@ +DOC_UPDATER = @MONODOCER@ -delete +DOC_ASSEMBLER = @MDASSEMBLER@ --out notify-sharp-docs --ecma + +ASSEMBLIES = \ + $(top_builddir)/src/notify-sharp.dll + +ASSEMBLIES_BUILD = $(foreach asm,$(ASSEMBLIES),$(addprefix -assembly:,$(asm))) + +if BUILD_DOCS + +monodocdir = $(DOCDIR) +monodoc_DATA = \ + notify-sharp-docs.zip \ + notify-sharp-docs.tree \ + $(srcdir)/notify-sharp-docs.source + +all: + +update-docs: $(ASSEMBLIES) + $(DOC_UPDATER) $(ASSEMBLIES_BUILD) -path:en + +notify-sharp-docs.zip notify-sharp-docs.tree: $(srcdir)/en/*/*.xml $(srcdir)/en/*.xml + $(DOC_ASSEMBLER) $(srcdir)/en + +endif + +EXTRA_DIST = \ + $(srcdir)/en/*.xml \ + $(srcdir)/en/*/*.xml \ + $(srcdir)/notify-sharp-docs.source + +DISTCLEANFILES = \ + notify-sharp-docs.zip \ + notify-sharp-docs.tree + +MAINTAINERCLEANFILES = \ + Makefile.in + diff --git a/docs/Makefile.in b/docs/Makefile.in new file mode 100644 index 0000000..fe967cd --- /dev/null +++ b/docs/Makefile.in @@ -0,0 +1,371 @@ +# Makefile.in generated by automake 1.10.1 from Makefile.am. +# @configure_input@ + +# Copyright (C) 1994, 1995, 1996, 1997, 1998, 1999, 2000, 2001, 2002, +# 2003, 2004, 2005, 2006, 2007, 2008 Free Software Foundation, Inc. +# This Makefile.in is free software; the Free Software Foundation +# gives unlimited permission to copy and/or distribute it, +# with or without modifications, as long as this notice is preserved. + +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY, to the extent permitted by law; without +# even the implied warranty of MERCHANTABILITY or FITNESS FOR A +# PARTICULAR PURPOSE. + +@SET_MAKE@ + +VPATH = @srcdir@ +pkgdatadir = $(datadir)/@PACKAGE@ +pkglibdir = $(libdir)/@PACKAGE@ +pkgincludedir = $(includedir)/@PACKAGE@ +am__cd = CDPATH="$${ZSH_VERSION+.}$(PATH_SEPARATOR)" && cd +install_sh_DATA = $(install_sh) -c -m 644 +install_sh_PROGRAM = $(install_sh) -c +install_sh_SCRIPT = $(install_sh) -c +INSTALL_HEADER = $(INSTALL_DATA) +transform = $(program_transform_name) +NORMAL_INSTALL = : +PRE_INSTALL = : +POST_INSTALL = : +NORMAL_UNINSTALL = : +PRE_UNINSTALL = : +POST_UNINSTALL = : +build_triplet = @build@ +host_triplet = @host@ +target_triplet = @target@ +subdir = docs +DIST_COMMON = $(srcdir)/Makefile.am $(srcdir)/Makefile.in +ACLOCAL_M4 = $(top_srcdir)/aclocal.m4 +am__aclocal_m4_deps = $(top_srcdir)/configure.ac +am__configure_deps = $(am__aclocal_m4_deps) $(CONFIGURE_DEPENDENCIES) \ + $(ACLOCAL_M4) +mkinstalldirs = $(install_sh) -d +CONFIG_CLEAN_FILES = +SOURCES = +DIST_SOURCES = +am__vpath_adj_setup = srcdirstrip=`echo "$(srcdir)" | sed 's|.|.|g'`; +am__vpath_adj = case $$p in \ + $(srcdir)/*) f=`echo "$$p" | sed "s|^$$srcdirstrip/||"`;; \ + *) f=$$p;; \ + esac; +am__strip_dir = `echo $$p | sed -e 's|^.*/||'`; +am__installdirs = "$(DESTDIR)$(monodocdir)" +monodocDATA_INSTALL = $(INSTALL_DATA) +DATA = $(monodoc_DATA) +DISTFILES = $(DIST_COMMON) $(DIST_SOURCES) $(TEXINFOS) $(EXTRA_DIST) +ACLOCAL = @ACLOCAL@ +AMTAR = @AMTAR@ +API_VERSION = @API_VERSION@ +AUTOCONF = @AUTOCONF@ +AUTOHEADER = @AUTOHEADER@ +AUTOMAKE = @AUTOMAKE@ +AWK = @AWK@ +CYGPATH_W = @CYGPATH_W@ +DEFS = @DEFS@ +DOCDIR = @DOCDIR@ +ECHO_C = @ECHO_C@ +ECHO_N = @ECHO_N@ +ECHO_T = @ECHO_T@ +GACUTIL = @GACUTIL@ +GMCS = @GMCS@ +GTK_SHARP_CFLAGS = @GTK_SHARP_CFLAGS@ +GTK_SHARP_LIBS = @GTK_SHARP_LIBS@ +INSTALL = @INSTALL@ +INSTALL_DATA = @INSTALL_DATA@ +INSTALL_PROGRAM = @INSTALL_PROGRAM@ +INSTALL_SCRIPT = @INSTALL_SCRIPT@ +INSTALL_STRIP_PROGRAM = @INSTALL_STRIP_PROGRAM@ +LIBOBJS = @LIBOBJS@ +LIBS = @LIBS@ +LTLIBOBJS = @LTLIBOBJS@ +MAINT = @MAINT@ +MAKEINFO = @MAKEINFO@ +MDASSEMBLER = @MDASSEMBLER@ +MKDIR_P = @MKDIR_P@ +MONODOCER = @MONODOCER@ +MONODOC_CFLAGS = @MONODOC_CFLAGS@ +MONODOC_LIBS = @MONODOC_LIBS@ +MONO_CFLAGS = @MONO_CFLAGS@ +MONO_LIBS = @MONO_LIBS@ +NDESK_DBUS_CFLAGS = @NDESK_DBUS_CFLAGS@ +NDESK_DBUS_LIBS = @NDESK_DBUS_LIBS@ +PACKAGE = @PACKAGE@ +PACKAGE_BUGREPORT = @PACKAGE_BUGREPORT@ +PACKAGE_NAME = @PACKAGE_NAME@ +PACKAGE_STRING = @PACKAGE_STRING@ +PACKAGE_TARNAME = @PACKAGE_TARNAME@ +PACKAGE_VERSION = @PACKAGE_VERSION@ +PATH_SEPARATOR = @PATH_SEPARATOR@ +PKG_CONFIG = @PKG_CONFIG@ +SET_MAKE = @SET_MAKE@ +SHELL = @SHELL@ +STRIP = @STRIP@ +VERSION = @VERSION@ +abs_builddir = @abs_builddir@ +abs_srcdir = @abs_srcdir@ +abs_top_builddir = @abs_top_builddir@ +abs_top_srcdir = @abs_top_srcdir@ +am__leading_dot = @am__leading_dot@ +am__tar = @am__tar@ +am__untar = @am__untar@ +bindir = @bindir@ +build = @build@ +build_alias = @build_alias@ +build_cpu = @build_cpu@ +build_os = @build_os@ +build_vendor = @build_vendor@ +builddir = @builddir@ +datadir = @datadir@ +datarootdir = @datarootdir@ +docdir = @docdir@ +dvidir = @dvidir@ +exec_prefix = @exec_prefix@ +host = @host@ +host_alias = @host_alias@ +host_cpu = @host_cpu@ +host_os = @host_os@ +host_vendor = @host_vendor@ +htmldir = @htmldir@ +includedir = @includedir@ +infodir = @infodir@ +install_sh = @install_sh@ +libdir = @libdir@ +libexecdir = @libexecdir@ +localedir = @localedir@ +localstatedir = @localstatedir@ +mandir = @mandir@ +mkdir_p = @mkdir_p@ +oldincludedir = @oldincludedir@ +pdfdir = @pdfdir@ +prefix = @prefix@ +program_transform_name = @program_transform_name@ +psdir = @psdir@ +sbindir = @sbindir@ +sharedstatedir = @sharedstatedir@ +srcdir = @srcdir@ +sysconfdir = @sysconfdir@ +target = @target@ +target_alias = @target_alias@ +target_cpu = @target_cpu@ +target_os = @target_os@ +target_vendor = @target_vendor@ +top_build_prefix = @top_build_prefix@ +top_builddir = @top_builddir@ +top_srcdir = @top_srcdir@ +DOC_UPDATER = @MONODOCER@ -delete +DOC_ASSEMBLER = @MDASSEMBLER@ --out notify-sharp-docs --ecma +ASSEMBLIES = \ + $(top_builddir)/src/notify-sharp.dll + +ASSEMBLIES_BUILD = $(foreach asm,$(ASSEMBLIES),$(addprefix -assembly:,$(asm))) +@BUILD_DOCS_TRUE@monodocdir = $(DOCDIR) +@BUILD_DOCS_TRUE@monodoc_DATA = \ +@BUILD_DOCS_TRUE@ notify-sharp-docs.zip \ +@BUILD_DOCS_TRUE@ notify-sharp-docs.tree \ +@BUILD_DOCS_TRUE@ $(srcdir)/notify-sharp-docs.source + +EXTRA_DIST = \ + $(srcdir)/en/*.xml \ + $(srcdir)/en/*/*.xml \ + $(srcdir)/notify-sharp-docs.source + +DISTCLEANFILES = \ + notify-sharp-docs.zip \ + notify-sharp-docs.tree + +MAINTAINERCLEANFILES = \ + Makefile.in + +all: all-am + +.SUFFIXES: +$(srcdir)/Makefile.in: @MAINTAINER_MODE_TRUE@ $(srcdir)/Makefile.am $(am__configure_deps) + @for dep in $?; do \ + case '$(am__configure_deps)' in \ + *$$dep*) \ + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh \ + && exit 0; \ + exit 1;; \ + esac; \ + done; \ + echo ' cd $(top_srcdir) && $(AUTOMAKE) --gnu docs/Makefile'; \ + cd $(top_srcdir) && \ + $(AUTOMAKE) --gnu docs/Makefile +.PRECIOUS: Makefile +Makefile: $(srcdir)/Makefile.in $(top_builddir)/config.status + @case '$?' in \ + *config.status*) \ + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh;; \ + *) \ + echo ' cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe)'; \ + cd $(top_builddir) && $(SHELL) ./config.status $(subdir)/$@ $(am__depfiles_maybe);; \ + esac; + +$(top_builddir)/config.status: $(top_srcdir)/configure $(CONFIG_STATUS_DEPENDENCIES) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh + +$(top_srcdir)/configure: @MAINTAINER_MODE_TRUE@ $(am__configure_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +$(ACLOCAL_M4): @MAINTAINER_MODE_TRUE@ $(am__aclocal_m4_deps) + cd $(top_builddir) && $(MAKE) $(AM_MAKEFLAGS) am--refresh +install-monodocDATA: $(monodoc_DATA) + @$(NORMAL_INSTALL) + test -z "$(monodocdir)" || $(MKDIR_P) "$(DESTDIR)$(monodocdir)" + @list='$(monodoc_DATA)'; for p in $$list; do \ + if test -f "$$p"; then d=; else d="$(srcdir)/"; fi; \ + f=$(am__strip_dir) \ + echo " $(monodocDATA_INSTALL) '$$d$$p' '$(DESTDIR)$(monodocdir)/$$f'"; \ + $(monodocDATA_INSTALL) "$$d$$p" "$(DESTDIR)$(monodocdir)/$$f"; \ + done + +uninstall-monodocDATA: + @$(NORMAL_UNINSTALL) + @list='$(monodoc_DATA)'; for p in $$list; do \ + f=$(am__strip_dir) \ + echo " rm -f '$(DESTDIR)$(monodocdir)/$$f'"; \ + rm -f "$(DESTDIR)$(monodocdir)/$$f"; \ + done +tags: TAGS +TAGS: + +ctags: CTAGS +CTAGS: + + +distdir: $(DISTFILES) + @srcdirstrip=`echo "$(srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + topsrcdirstrip=`echo "$(top_srcdir)" | sed 's/[].[^$$\\*]/\\\\&/g'`; \ + list='$(DISTFILES)'; \ + dist_files=`for file in $$list; do echo $$file; done | \ + sed -e "s|^$$srcdirstrip/||;t" \ + -e "s|^$$topsrcdirstrip/|$(top_builddir)/|;t"`; \ + case $$dist_files in \ + */*) $(MKDIR_P) `echo "$$dist_files" | \ + sed '/\//!d;s|^|$(distdir)/|;s,/[^/]*$$,,' | \ + sort -u` ;; \ + esac; \ + for file in $$dist_files; do \ + if test -f $$file || test -d $$file; then d=.; else d=$(srcdir); fi; \ + if test -d $$d/$$file; then \ + dir=`echo "/$$file" | sed -e 's,/[^/]*$$,,'`; \ + if test -d $(srcdir)/$$file && test $$d != $(srcdir); then \ + cp -pR $(srcdir)/$$file $(distdir)$$dir || exit 1; \ + fi; \ + cp -pR $$d/$$file $(distdir)$$dir || exit 1; \ + else \ + test -f $(distdir)/$$file \ + || cp -p $$d/$$file $(distdir)/$$file \ + || exit 1; \ + fi; \ + done +check-am: all-am +check: check-am +all-am: Makefile $(DATA) +installdirs: + for dir in "$(DESTDIR)$(monodocdir)"; do \ + test -z "$$dir" || $(MKDIR_P) "$$dir"; \ + done +install: install-am +install-exec: install-exec-am +install-data: install-data-am +uninstall: uninstall-am + +install-am: all-am + @$(MAKE) $(AM_MAKEFLAGS) install-exec-am install-data-am + +installcheck: installcheck-am +install-strip: + $(MAKE) $(AM_MAKEFLAGS) INSTALL_PROGRAM="$(INSTALL_STRIP_PROGRAM)" \ + install_sh_PROGRAM="$(INSTALL_STRIP_PROGRAM)" INSTALL_STRIP_FLAG=-s \ + `test -z '$(STRIP)' || \ + echo "INSTALL_PROGRAM_ENV=STRIPPROG='$(STRIP)'"` install +mostlyclean-generic: + +clean-generic: + +distclean-generic: + -test -z "$(CONFIG_CLEAN_FILES)" || rm -f $(CONFIG_CLEAN_FILES) + -test -z "$(DISTCLEANFILES)" || rm -f $(DISTCLEANFILES) + +maintainer-clean-generic: + @echo "This command is intended for maintainers to use" + @echo "it deletes files that may require special tools to rebuild." + -test -z "$(MAINTAINERCLEANFILES)" || rm -f $(MAINTAINERCLEANFILES) +clean: clean-am + +clean-am: clean-generic mostlyclean-am + +distclean: distclean-am + -rm -f Makefile +distclean-am: clean-am distclean-generic + +dvi: dvi-am + +dvi-am: + +html: html-am + +info: info-am + +info-am: + +install-data-am: install-monodocDATA + +install-dvi: install-dvi-am + +install-exec-am: + +install-html: install-html-am + +install-info: install-info-am + +install-man: + +install-pdf: install-pdf-am + +install-ps: install-ps-am + +installcheck-am: + +maintainer-clean: maintainer-clean-am + -rm -f Makefile +maintainer-clean-am: distclean-am maintainer-clean-generic + +mostlyclean: mostlyclean-am + +mostlyclean-am: mostlyclean-generic + +pdf: pdf-am + +pdf-am: + +ps: ps-am + +ps-am: + +uninstall-am: uninstall-monodocDATA + +.MAKE: install-am install-strip + +.PHONY: all all-am check check-am clean clean-generic distclean \ + distclean-generic distdir dvi dvi-am html html-am info info-am \ + install install-am install-data install-data-am install-dvi \ + install-dvi-am install-exec install-exec-am install-html \ + install-html-am install-info install-info-am install-man \ + install-monodocDATA install-pdf install-pdf-am install-ps \ + install-ps-am install-strip installcheck installcheck-am \ + installdirs maintainer-clean maintainer-clean-generic \ + mostlyclean mostlyclean-generic pdf pdf-am ps ps-am uninstall \ + uninstall-am uninstall-monodocDATA + + +@BUILD_DOCS_TRUE@all: + +@BUILD_DOCS_TRUE@update-docs: $(ASSEMBLIES) +@BUILD_DOCS_TRUE@ $(DOC_UPDATER) $(ASSEMBLIES_BUILD) -path:en + +@BUILD_DOCS_TRUE@notify-sharp-docs.zip notify-sharp-docs.tree: $(srcdir)/en/*/*.xml $(srcdir)/en/*.xml +@BUILD_DOCS_TRUE@ $(DOC_ASSEMBLER) $(srcdir)/en +# Tell versions [3.59,3.63) of GNU make to not export all variables. +# Otherwise a system limit (for SysV at least) may be exceeded. +.NOEXPORT: diff --git a/docs/en/Notifications.xml b/docs/en/Notifications.xml new file mode 100644 index 0000000..b3385cc --- /dev/null +++ b/docs/en/Notifications.xml @@ -0,0 +1,6 @@ +<Namespace Name="Notifications"> + <Docs> + <summary>To be added.</summary> + <remarks>To be added.</remarks> + </Docs> +</Namespace> diff --git a/docs/en/Notifications/ActionArgs.xml b/docs/en/Notifications/ActionArgs.xml new file mode 100644 index 0000000..827aaa4 --- /dev/null +++ b/docs/en/Notifications/ActionArgs.xml @@ -0,0 +1,29 @@ +<Type Name="ActionArgs" FullName="Notifications.ActionArgs"> + <TypeSignature Language="C#" Value="public class ActionArgs : EventArgs" /> + <AssemblyInfo> + <AssemblyName>notify-sharp</AssemblyName> + <AssemblyVersion>0.4.0.0</AssemblyVersion> + </AssemblyInfo> + <Base> + <BaseTypeName>System.EventArgs</BaseTypeName> + </Base> + <Interfaces /> + <Docs> + <summary>To be added.</summary> + <remarks>To be added.</remarks> + </Docs> + <Members> + + <Member MemberName=".ctor"> + <MemberSignature Language="C#" Value="public ActionArgs (string action);" /> + <MemberType>Constructor</MemberType> + <Parameters><Parameter Name="action" Type="System.String" /></Parameters> + <Docs><param name="action">To be added.</param><summary>To be added.</summary><remarks>To be added.</remarks></Docs> + </Member><Member MemberName="Action"> + <MemberSignature Language="C#" Value="public string Action { get; };" /> + <MemberType>Property</MemberType> + <ReturnValue><ReturnType>System.String</ReturnType></ReturnValue> + <Docs><summary>To be added.</summary><value>To be added.</value><remarks>To be added.</remarks></Docs> + </Member> + </Members> +</Type> diff --git a/docs/en/Notifications/ActionHandler.xml b/docs/en/Notifications/ActionHandler.xml new file mode 100644 index 0000000..2d7c464 --- /dev/null +++ b/docs/en/Notifications/ActionHandler.xml @@ -0,0 +1,23 @@ +<Type Name="ActionHandler" FullName="Notifications.ActionHandler"> + <TypeSignature Language="C#" Value="public delegate void ActionHandler(object o, ActionArgs args);" /> + <AssemblyInfo> + <AssemblyName>notify-sharp</AssemblyName> + <AssemblyVersion>0.4.0.0</AssemblyVersion> + </AssemblyInfo> + <Base> + <BaseTypeName>System.Delegate</BaseTypeName> + </Base> + <Parameters> + <Parameter Name="o" Type="System.Object" /> + <Parameter Name="args" Type="Notifications.ActionArgs" /> + </Parameters> + <ReturnValue> + <ReturnType>System.Void</ReturnType> + </ReturnValue> + <Docs> + <param name="o">To be added.</param> + <param name="args">To be added.</param> + <summary>To be added.</summary> + <remarks>To be added.</remarks> + </Docs> +</Type> diff --git a/docs/en/Notifications/CloseArgs.xml b/docs/en/Notifications/CloseArgs.xml new file mode 100644 index 0000000..c19fc0a --- /dev/null +++ b/docs/en/Notifications/CloseArgs.xml @@ -0,0 +1,29 @@ +<Type Name="CloseArgs" FullName="Notifications.CloseArgs"> + <TypeSignature Language="C#" Value="public class CloseArgs : EventArgs" /> + <AssemblyInfo> + <AssemblyName>notify-sharp</AssemblyName> + <AssemblyVersion>0.4.0.0</AssemblyVersion> + </AssemblyInfo> + <Base> + <BaseTypeName>System.EventArgs</BaseTypeName> + </Base> + <Interfaces /> + <Docs> + <summary>To be added.</summary> + <remarks>To be added.</remarks> + </Docs> + <Members> + + <Member MemberName=".ctor"> + <MemberSignature Language="C#" Value="public CloseArgs (Notifications.CloseReason reason);" /> + <MemberType>Constructor</MemberType> + <Parameters><Parameter Name="reason" Type="Notifications.CloseReason" /></Parameters> + <Docs><param name="reason">To be added.</param><summary>To be added.</summary><remarks>To be added.</remarks></Docs> + </Member><Member MemberName="Reason"> + <MemberSignature Language="C#" Value="public Notifications.CloseReason Reason { get; };" /> + <MemberType>Property</MemberType> + <ReturnValue><ReturnType>Notifications.CloseReason</ReturnType></ReturnValue> + <Docs><summary>To be added.</summary><value>To be added.</value><remarks>To be added.</remarks></Docs> + </Member> + </Members> +</Type> diff --git a/docs/en/Notifications/CloseHandler.xml b/docs/en/Notifications/CloseHandler.xml new file mode 100644 index 0000000..5a8c9ff --- /dev/null +++ b/docs/en/Notifications/CloseHandler.xml @@ -0,0 +1,23 @@ +<Type Name="CloseHandler" FullName="Notifications.CloseHandler"> + <TypeSignature Language="C#" Value="public delegate void CloseHandler(object o, CloseArgs args);" /> + <AssemblyInfo> + <AssemblyName>notify-sharp</AssemblyName> + <AssemblyVersion>0.4.0.0</AssemblyVersion> + </AssemblyInfo> + <Base> + <BaseTypeName>System.Delegate</BaseTypeName> + </Base> + <Parameters> + <Parameter Name="o" Type="System.Object" /> + <Parameter Name="args" Type="Notifications.CloseArgs" /> + </Parameters> + <ReturnValue> + <ReturnType>System.Void</ReturnType> + </ReturnValue> + <Docs> + <param name="o">To be added.</param> + <param name="args">To be added.</param> + <summary>To be added.</summary> + <remarks>To be added.</remarks> + </Docs> +</Type> diff --git a/docs/en/Notifications/CloseReason.xml b/docs/en/Notifications/CloseReason.xml new file mode 100644 index 0000000..70407b4 --- /dev/null +++ b/docs/en/Notifications/CloseReason.xml @@ -0,0 +1,40 @@ +<Type Name="CloseReason" FullName="Notifications.CloseReason"> + <TypeSignature Language="C#" Value="public enum CloseReason" /> + <AssemblyInfo> + <AssemblyName>notify-sharp</AssemblyName> + <AssemblyVersion>0.4.0.0</AssemblyVersion> + </AssemblyInfo> + <Base> + <BaseTypeName>System.Enum</BaseTypeName> + </Base> + <Docs> + <summary>To be added.</summary> + <remarks>To be added.</remarks> + </Docs> + <Members> + + + + <Member MemberName="API"> + <MemberSignature Language="C#" Value="API" /> + <MemberType>Field</MemberType> + <ReturnValue><ReturnType>Notifications.CloseReason</ReturnType></ReturnValue> + <Docs><summary>To be added.</summary></Docs> + </Member><Member MemberName="Expired"> + <MemberSignature Language="C#" Value="Expired" /> + <MemberType>Field</MemberType> + <ReturnValue><ReturnType>Notifications.CloseReason</ReturnType></ReturnValue> + <Docs><summary>To be added.</summary></Docs> + </Member><Member MemberName="Reserved"> + <MemberSignature Language="C#" Value="Reserved" /> + <MemberType>Field</MemberType> + <ReturnValue><ReturnType>Notifications.CloseReason</ReturnType></ReturnValue> + <Docs><summary>To be added.</summary></Docs> + </Member><Member MemberName="User"> + <MemberSignature Language="C#" Value="User" /> + <MemberType>Field</MemberType> + <ReturnValue><ReturnType>Notifications.CloseReason</ReturnType></ReturnValue> + <Docs><summary>To be added.</summary></Docs> + </Member> + </Members> +</Type> diff --git a/docs/en/Notifications/Global.xml b/docs/en/Notifications/Global.xml new file mode 100644 index 0000000..ce063a1 --- /dev/null +++ b/docs/en/Notifications/Global.xml @@ -0,0 +1,29 @@ +<Type Name="Global" FullName="Notifications.Global"> + <TypeSignature Language="C#" Value="public static class Global" /> + <AssemblyInfo> + <AssemblyName>notify-sharp</AssemblyName> + <AssemblyVersion>0.4.0.0</AssemblyVersion> + </AssemblyInfo> + <Base> + <BaseTypeName>System.Object</BaseTypeName> + </Base> + <Interfaces /> + <Docs> + <summary>To be added.</summary> + <remarks>To be added.</remarks> + </Docs> + <Members> + + <Member MemberName="Capabilities"> + <MemberSignature Language="C#" Value="public static string[] Capabilities { get; };" /> + <MemberType>Property</MemberType> + <ReturnValue><ReturnType>System.String[]</ReturnType></ReturnValue> + <Docs><summary>To be added.</summary><value>To be added.</value><remarks>To be added.</remarks></Docs> + </Member><Member MemberName="ServerInformation"> + <MemberSignature Language="C#" Value="public static Notifications.ServerInformation ServerInformation { get; };" /> + <MemberType>Property</MemberType> + <ReturnValue><ReturnType>Notifications.ServerInformation</ReturnType></ReturnValue> + <Docs><summary>To be added.</summary><value>To be added.</value><remarks>To be added.</remarks></Docs> + </Member> + </Members> +</Type> diff --git a/docs/en/Notifications/Notification.xml b/docs/en/Notifications/Notification.xml new file mode 100644 index 0000000..557c07d --- /dev/null +++ b/docs/en/Notifications/Notification.xml @@ -0,0 +1,164 @@ +<Type Name="Notification" FullName="Notifications.Notification"> + <TypeSignature Language="C#" Value="public class Notification" /> + <AssemblyInfo> + <AssemblyName>notify-sharp</AssemblyName> + <AssemblyVersion>0.4.0.0</AssemblyVersion> + </AssemblyInfo> + <Base> + <BaseTypeName>System.Object</BaseTypeName> + </Base> + <Interfaces /> + <Docs> + <summary>To be added.</summary> + <remarks>To be added.</remarks> + </Docs> + <Members> + + + + + + + + + + + + + + + + + + + + + + + <Member MemberName=".ctor"> + <MemberSignature Language="C#" Value="public Notification ();" /> + <MemberType>Constructor</MemberType> + <Parameters /> + <Docs><summary>To be added.</summary><remarks>To be added.</remarks></Docs> + </Member><Member MemberName=".ctor"> + <MemberSignature Language="C#" Value="public Notification (string summary, string body);" /> + <MemberType>Constructor</MemberType> + <Parameters><Parameter Name="summary" Type="System.String" /><Parameter Name="body" Type="System.String" /></Parameters> + <Docs><param name="summary">To be added.</param><param name="body">To be added.</param><summary>To be added.</summary><remarks>To be added.</remarks></Docs> + </Member><Member MemberName=".ctor"> + <MemberSignature Language="C#" Value="public Notification (string summary, string body, Gdk.Pixbuf icon);" /> + <MemberType>Constructor</MemberType> + <Parameters><Parameter Name="summary" Type="System.String" /><Parameter Name="body" Type="System.String" /><Parameter Name="icon" Type="Gdk.Pixbuf" /></Parameters> + <Docs><param name="summary">To be added.</param><param name="body">To be added.</param><param name="icon">To be added.</param><summary>To be added.</summary><remarks>To be added.</remarks></Docs> + </Member><Member MemberName=".ctor"> + <MemberSignature Language="C#" Value="public Notification (string summary, string body, string icon);" /> + <MemberType>Constructor</MemberType> + <Parameters><Parameter Name="summary" Type="System.String" /><Parameter Name="body" Type="System.String" /><Parameter Name="icon" Type="System.String" /></Parameters> + <Docs><param name="summary">To be added.</param><param name="body">To be added.</param><param name="icon">To be added.</param><summary>To be added.</summary><remarks>To be added.</remarks></Docs> + </Member><Member MemberName=".ctor"><MemberSignature Language="C#" Value="public Notification (string summary, string body, Gdk.Pixbuf icon, Gtk.StatusIcon status_icon);" /><MemberType>Constructor</MemberType><Parameters><Parameter Name="summary" Type="System.String" /><Parameter Name="body" Type="System.String" /><Parameter Name="icon" Type="Gdk.Pixbuf" /><Parameter Name="status_icon" Type="Gtk.StatusIcon" /></Parameters><Docs><param name="summary">To be added.</param><param name="body">To be added.</param><param name="icon">To be added.</param><param name="status_icon">To be added.</param><summary>To be added.</summary><remarks>To be added.</remarks></Docs></Member><Member MemberName=".ctor"> + <MemberSignature Language="C#" Value="public Notification (string summary, string body, Gdk.Pixbuf icon, Gtk.Widget widget);" /> + <MemberType>Constructor</MemberType> + <Parameters><Parameter Name="summary" Type="System.String" /><Parameter Name="body" Type="System.String" /><Parameter Name="icon" Type="Gdk.Pixbuf" /><Parameter Name="widget" Type="Gtk.Widget" /></Parameters> + <Docs><param name="summary">To be added.</param><param name="body">To be added.</param><param name="icon">To be added.</param><param name="widget">To be added.</param><summary>To be added.</summary><remarks>To be added.</remarks></Docs> + </Member><Member MemberName=".ctor"><MemberSignature Language="C#" Value="public Notification (string summary, string body, string icon, Gtk.StatusIcon status_icon);" /><MemberType>Constructor</MemberType><Parameters><Parameter Name="summary" Type="System.String" /><Parameter Name="body" Type="System.String" /><Parameter Name="icon" Type="System.String" /><Parameter Name="status_icon" Type="Gtk.StatusIcon" /></Parameters><Docs><param name="summary">To be added.</param><param name="body">To be added.</param><param name="icon">To be added.</param><param name="status_icon">To be added.</param><summary>To be added.</summary><remarks>To be added.</remarks></Docs></Member><Member MemberName=".ctor"> + <MemberSignature Language="C#" Value="public Notification (string summary, string body, string icon, Gtk.Widget widget);" /> + <MemberType>Constructor</MemberType> + <Parameters><Parameter Name="summary" Type="System.String" /><Parameter Name="body" Type="System.String" /><Parameter Name="icon" Type="System.String" /><Parameter Name="widget" Type="Gtk.Widget" /></Parameters> + <Docs><param name="summary">To be added.</param><param name="body">To be added.</param><param name="icon">To be added.</param><param name="widget">To be added.</param><summary>To be added.</summary><remarks>To be added.</remarks></Docs> + </Member><Member MemberName="AddAction"> + <MemberSignature Language="C#" Value="public void AddAction (string action, string label, Notifications.ActionHandler handler);" /> + <MemberType>Method</MemberType> + <ReturnValue><ReturnType>System.Void</ReturnType></ReturnValue> + <Parameters><Parameter Name="action" Type="System.String" /><Parameter Name="label" Type="System.String" /><Parameter Name="handler" Type="Notifications.ActionHandler" /></Parameters> + <Docs><param name="action">To be added.</param><param name="label">To be added.</param><param name="handler">To be added.</param><summary>To be added.</summary><remarks>To be added.</remarks></Docs> + </Member><Member MemberName="AddHint"> + <MemberSignature Language="C#" Value="public void AddHint (string name, object value);" /> + <MemberType>Method</MemberType> + <ReturnValue><ReturnType>System.Void</ReturnType></ReturnValue> + <Parameters><Parameter Name="name" Type="System.String" /><Parameter Name="value" Type="System.Object" /></Parameters> + <Docs><param name="name">To be added.</param><param name="value">To be added.</param><summary>To be added.</summary><remarks>To be added.</remarks></Docs> + </Member><Member MemberName="AttachToStatusIcon"><MemberSignature Language="C#" Value="public void AttachToStatusIcon (Gtk.StatusIcon status_icon);" /><MemberType>Method</MemberType><ReturnValue><ReturnType>System.Void</ReturnType></ReturnValue><Parameters><Parameter Name="status_icon" Type="Gtk.StatusIcon" /></Parameters><Docs><param name="status_icon">To be added.</param><summary>To be added.</summary><remarks>To be added.</remarks></Docs></Member><Member MemberName="AttachToWidget"> + <MemberSignature Language="C#" Value="public void AttachToWidget (Gtk.Widget widget);" /> + <MemberType>Method</MemberType> + <ReturnValue><ReturnType>System.Void</ReturnType></ReturnValue> + <Parameters><Parameter Name="widget" Type="Gtk.Widget" /></Parameters> + <Docs><param name="widget">To be added.</param><summary>To be added.</summary><remarks>To be added.</remarks></Docs> + </Member><Member MemberName="AttachWidget"><MemberSignature Language="C#" Value="public Gtk.Widget AttachWidget { set; get; };" /><MemberType>Property</MemberType><ReturnValue><ReturnType>Gtk.Widget</ReturnType></ReturnValue><Docs><summary>To be added.</summary><value>To be added.</value><remarks>To be added.</remarks></Docs></Member><Member MemberName="Body"> + <MemberSignature Language="C#" Value="public string Body { set; get; };" /> + <MemberType>Property</MemberType> + <ReturnValue><ReturnType>System.String</ReturnType></ReturnValue> + <Docs><summary>To be added.</summary><value>To be added.</value><remarks>To be added.</remarks></Docs> + </Member><Member MemberName="Category"> + <MemberSignature Language="C#" Value="public string Category { set; get; };" /> + <MemberType>Property</MemberType> + <ReturnValue><ReturnType>System.String</ReturnType></ReturnValue> + <Docs><summary>To be added.</summary><value>To be added.</value><remarks>To be added.</remarks></Docs> + </Member><Member MemberName="ClearActions"> + <MemberSignature Language="C#" Value="public void ClearActions ();" /> + <MemberType>Method</MemberType> + <ReturnValue><ReturnType>System.Void</ReturnType></ReturnValue> + <Parameters /> + <Docs><summary>To be added.</summary><remarks>To be added.</remarks></Docs> + </Member><Member MemberName="Close"> + <MemberSignature Language="C#" Value="public void Close ();" /> + <MemberType>Method</MemberType> + <ReturnValue><ReturnType>System.Void</ReturnType></ReturnValue> + <Parameters /> + <Docs><summary>To be added.</summary><remarks>To be added.</remarks></Docs> + </Member><Member MemberName="Closed"> + <MemberSignature Language="C#" Value="public event EventHandler Closed;" /> + <MemberType>Event</MemberType> + <ReturnValue><ReturnType>System.EventHandler</ReturnType></ReturnValue> + <Docs><summary>To be added.</summary><remarks>To be added.</remarks></Docs> + </Member><Member MemberName="Icon"> + <MemberSignature Language="C#" Value="public Gdk.Pixbuf Icon { set; };" /> + <MemberType>Property</MemberType> + <ReturnValue><ReturnType>Gdk.Pixbuf</ReturnType></ReturnValue> + <Docs><summary>To be added.</summary><value>To be added.</value><remarks>To be added.</remarks></Docs> + </Member><Member MemberName="IconName"> + <MemberSignature Language="C#" Value="public string IconName { set; };" /> + <MemberType>Property</MemberType> + <ReturnValue><ReturnType>System.String</ReturnType></ReturnValue> + <Docs><summary>To be added.</summary><value>To be added.</value><remarks>To be added.</remarks></Docs> + </Member><Member MemberName="Id"><MemberSignature Language="C#" Value="public uint Id { get; };" /><MemberType>Property</MemberType><ReturnValue><ReturnType>System.UInt32</ReturnType></ReturnValue><Docs><summary>To be added.</summary><value>To be added.</value><remarks>To be added.</remarks></Docs></Member><Member MemberName="RemoveAction"> + <MemberSignature Language="C#" Value="public void RemoveAction (string action);" /> + <MemberType>Method</MemberType> + <ReturnValue><ReturnType>System.Void</ReturnType></ReturnValue> + <Parameters><Parameter Name="action" Type="System.String" /></Parameters> + <Docs><param name="action">To be added.</param><summary>To be added.</summary><remarks>To be added.</remarks></Docs> + </Member><Member MemberName="RemoveHint"> + <MemberSignature Language="C#" Value="public void RemoveHint (string name);" /> + <MemberType>Method</MemberType> + <ReturnValue><ReturnType>System.Void</ReturnType></ReturnValue> + <Parameters><Parameter Name="name" Type="System.String" /></Parameters> + <Docs><param name="name">To be added.</param><summary>To be added.</summary><remarks>To be added.</remarks></Docs> + </Member><Member MemberName="SetGeometryHints"> + <MemberSignature Language="C#" Value="public void SetGeometryHints (Gdk.Screen screen, int x, int y);" /> + <MemberType>Method</MemberType> + <ReturnValue><ReturnType>System.Void</ReturnType></ReturnValue> + <Parameters><Parameter Name="screen" Type="Gdk.Screen" /><Parameter Name="x" Type="System.Int32" /><Parameter Name="y" Type="System.Int32" /></Parameters> + <Docs><param name="screen">To be added.</param><param name="x">To be added.</param><param name="y">To be added.</param><summary>To be added.</summary><remarks>To be added.</remarks></Docs> + </Member><Member MemberName="Show"> + <MemberSignature Language="C#" Value="public void Show ();" /> + <MemberType>Method</MemberType> + <ReturnValue><ReturnType>System.Void</ReturnType></ReturnValue> + <Parameters /> + <Docs><summary>To be added.</summary><remarks>To be added.</remarks></Docs> + </Member><Member MemberName="StatusIcon"><MemberSignature Language="C#" Value="public Gtk.StatusIcon StatusIcon { set; get; };" /><MemberType>Property</MemberType><ReturnValue><ReturnType>Gtk.StatusIcon</ReturnType></ReturnValue><Docs><summary>To be added.</summary><value>To be added.</value><remarks>To be added.</remarks></Docs></Member><Member MemberName="Summary"> + <MemberSignature Language="C#" Value="public string Summary { set; get; };" /> + <MemberType>Property</MemberType> + <ReturnValue><ReturnType>System.String</ReturnType></ReturnValue> + <Docs><summary>To be added.</summary><value>To be added.</value><remarks>To be added.</remarks></Docs> + </Member><Member MemberName="Timeout"> + <MemberSignature Language="C#" Value="public int Timeout { set; get; };" /> + <MemberType>Property</MemberType> + <ReturnValue><ReturnType>System.Int32</ReturnType></ReturnValue> + <Docs><summary>To be added.</summary><value>To be added.</value><remarks>To be added.</remarks></Docs> + </Member><Member MemberName="Urgency"> + <MemberSignature Language="C#" Value="public Notifications.Urgency Urgency { set; get; };" /> + <MemberType>Property</MemberType> + <ReturnValue><ReturnType>Notifications.Urgency</ReturnType></ReturnValue> + <Docs><summary>To be added.</summary><value>To be added.</value><remarks>To be added.</remarks></Docs> + </Member> + </Members> +</Type> diff --git a/docs/en/Notifications/ServerInformation.xml b/docs/en/Notifications/ServerInformation.xml new file mode 100644 index 0000000..e6d4800 --- /dev/null +++ b/docs/en/Notifications/ServerInformation.xml @@ -0,0 +1,41 @@ +<Type Name="ServerInformation" FullName="Notifications.ServerInformation"> + <TypeSignature Language="C#" Value="public struct ServerInformation" /> + <AssemblyInfo> + <AssemblyName>notify-sharp</AssemblyName> + <AssemblyVersion>0.4.0.0</AssemblyVersion> + </AssemblyInfo> + <Base> + <BaseTypeName>System.ValueType</BaseTypeName> + </Base> + <Interfaces /> + <Docs> + <summary>To be added.</summary> + <remarks>To be added.</remarks> + </Docs> + <Members> + + + + <Member MemberName="Name"> + <MemberSignature Language="C#" Value="public string Name;" /> + <MemberType>Field</MemberType> + <ReturnValue><ReturnType>System.String</ReturnType></ReturnValue> + <Docs><summary>To be added.</summary><remarks>To be added.</remarks></Docs> + </Member><Member MemberName="SpecVersion"> + <MemberSignature Language="C#" Value="public string SpecVersion;" /> + <MemberType>Field</MemberType> + <ReturnValue><ReturnType>System.String</ReturnType></ReturnValue> + <Docs><summary>To be added.</summary><remarks>To be added.</remarks></Docs> + </Member><Member MemberName="Vendor"> + <MemberSignature Language="C#" Value="public string Vendor;" /> + <MemberType>Field</MemberType> + <ReturnValue><ReturnType>System.String</ReturnType></ReturnValue> + <Docs><summary>To be added.</summary><remarks>To be added.</remarks></Docs> + </Member><Member MemberName="Version"> + <MemberSignature Language="C#" Value="public string Version;" /> + <MemberType>Field</MemberType> + <ReturnValue><ReturnType>System.String</ReturnType></ReturnValue> + <Docs><summary>To be added.</summary><remarks>To be added.</remarks></Docs> + </Member> + </Members> +</Type> diff --git a/docs/en/Notifications/Urgency.xml b/docs/en/Notifications/Urgency.xml new file mode 100644 index 0000000..bf6ebfb --- /dev/null +++ b/docs/en/Notifications/Urgency.xml @@ -0,0 +1,34 @@ +<Type Name="Urgency" FullName="Notifications.Urgency"> + <TypeSignature Language="C#" Value="public enum Urgency" /> + <AssemblyInfo> + <AssemblyName>notify-sharp</AssemblyName> + <AssemblyVersion>0.4.0.0</AssemblyVersion> + </AssemblyInfo> + <Base> + <BaseTypeName>System.Enum</BaseTypeName> + </Base> + <Docs> + <summary>To be added.</summary> + <remarks>To be added.</remarks> + </Docs> + <Members> + + + <Member MemberName="Critical"> + <MemberSignature Language="C#" Value="Critical" /> + <MemberType>Field</MemberType> + <ReturnValue><ReturnType>Notifications.Urgency</ReturnType></ReturnValue> + <Docs><summary>To be added.</summary></Docs> + </Member><Member MemberName="Low"> + <MemberSignature Language="C#" Value="Low" /> + <MemberType>Field</MemberType> + <ReturnValue><ReturnType>Notifications.Urgency</ReturnType></ReturnValue> + <Docs><summary>To be added.</summary></Docs> + </Member><Member MemberName="Normal"> + <MemberSignature Language="C#" Value="Normal" /> + <MemberType>Field</MemberType> + <ReturnValue><ReturnType>Notifications.Urgency</ReturnType></ReturnValue> + <Docs><summary>To be added.</summary></Docs> + </Member> + </Members> +</Type> diff --git a/docs/en/index.xml b/docs/en/index.xml new file mode 100644 index 0000000..5e9ad15 --- /dev/null +++ b/docs/en/index.xml @@ -0,0 +1,36 @@ +<Overview> + <Assemblies> + <Assembly Name="notify-sharp" Version="0.4.0.0"> + <Attributes> + <Attribute> + <AttributeName>System.Runtime.CompilerServices.RuntimeCompatibility(WrapNonExceptionThrows=true)</AttributeName> + </Attribute> + <Attribute> + <AttributeName>System.Reflection.AssemblyCopyright("Copyright (c) 2006-2007 Sebastian Dröge")</AttributeName> + </Attribute> + <Attribute> + <AttributeName>System.Reflection.AssemblyDescription("C# client library for notification-daemon")</AttributeName> + </Attribute> + <Attribute> + <AttributeName>System.Reflection.AssemblyTitle("notify-sharp")</AttributeName> + </Attribute> + </Attributes> + </Assembly> + </Assemblies> + <Remarks>To be added.</Remarks> + <Copyright>To be added.</Copyright> + <Types> + <Namespace Name="Notifications"> + <Type Name="ActionArgs" /> + <Type Name="ActionHandler" /> + <Type Name="CloseArgs" /> + <Type Name="CloseHandler" /> + <Type Name="CloseReason" /> + <Type Name="Global" /> + <Type Name="Notification" /> + <Type Name="ServerInformation" /> + <Type Name="Urgency" /> + </Namespace> + </Types> + <Title>notify-sharp</Title> +</Overview> diff --git a/docs/notify-sharp-docs.source b/docs/notify-sharp-docs.source new file mode 100644 index 0000000..2300186 --- /dev/null +++ b/docs/notify-sharp-docs.source @@ -0,0 +1,5 @@ +<?xml version="1.0"?> +<monodoc> + <source provider="ecma" basefile="notify-sharp-docs" path="various" title="Notifications" /> +</monodoc> + |