From 971d0cad693e743293c76897f853f0b3e4682103 Mon Sep 17 00:00:00 2001 From: Aaron Bockover Date: Tue, 11 Oct 2005 19:17:32 +0000 Subject: [PATCH] Add documentation svn path=/trunk/njb-sharp/; revision=51631 --- configure.ac | 31 ++- src/AssemblyInfo.cs.in | 39 +++ src/Makefile.am | 32 ++- src/en/Njb.xml | 6 + src/en/Njb/Device.xml | 367 ++++++++++++++++++++++++++++ src/en/Njb/Discoverer.xml | 91 +++++++ src/en/Njb/ForeachErrorCallback.xml | 21 ++ src/en/Njb/Global+DebugFlags.xml | 66 +++++ src/en/Njb/Global.xml | 50 ++++ src/en/Njb/Revision.xml | 59 +++++ src/en/Njb/Song.xml | 90 +++++++ src/en/Njb/SongFrame.xml | 89 +++++++ src/en/Njb/SongFrameType.xml | 46 ++++ src/en/index.xml | 36 +++ src/njb-sharp-docs.source | 5 + 15 files changed, 1021 insertions(+), 7 deletions(-) create mode 100644 src/AssemblyInfo.cs.in create mode 100644 src/en/Njb.xml create mode 100644 src/en/Njb/Device.xml create mode 100644 src/en/Njb/Discoverer.xml create mode 100644 src/en/Njb/ForeachErrorCallback.xml create mode 100644 src/en/Njb/Global+DebugFlags.xml create mode 100644 src/en/Njb/Global.xml create mode 100644 src/en/Njb/Revision.xml create mode 100644 src/en/Njb/Song.xml create mode 100644 src/en/Njb/SongFrame.xml create mode 100644 src/en/Njb/SongFrameType.xml create mode 100644 src/en/index.xml create mode 100644 src/njb-sharp-docs.source diff --git a/configure.ac b/configure.ac index b29b5a2..469c477 100644 --- a/configure.ac +++ b/configure.ac @@ -19,19 +19,42 @@ AM_PROG_LIBTOOL PKG_CHECK_MODULES(NJB, libnjb >= 2.2.4) -AC_PATH_PROG(MONO, mono) -if test "x$MONO" = "x"; then +AC_PATH_PROG(MONO, mono, no) +if test "x$MONO" = "xno"; then AC_MSG_ERROR([Can not find "mono" in your PATH]) fi -AC_PATH_PROG(MCS, mcs) -if test "x$MCS" = "x"; then +AC_PATH_PROG(MCS, mcs, no) +if test "x$MCS" = "xno"; then AC_MSG_ERROR([Can not find "mcs" in your PATH]) fi +AC_ARG_ENABLE(docs, AC_HELP_STRING([--disable-docs], [Do not build documentation]), with_docs=no, with_docs=yes) + +if test "x$with_docs" = "xyes"; then + AC_PATH_PROG(MONODOCER, monodocer, no) + if test "x$MONODOC" = "xno"; then + AC_MSG_ERROR([You need to install monodoc]) + fi + + AC_PATH_PROG(MDASSEMBLER, mdassembler, no) + if test "x$MDASSEMBLER" = "xno"; then + AC_MSG_ERROR([You need to install mdassembler]) + fi + + DOCDIR=`$PKG_CONFIG monodoc --variable=sourcesdir` + AC_SUBST(DOCDIR) + + AM_CONDITIONAL(BUILD_DOCS, true) +else + AC_MSG_NOTICE([not building API documentation]) + AM_CONDITIONAL(BUILD_DOCS, false) +fi + AC_OUTPUT([ Makefile njb-sharp.pc src/Makefile + src/AssemblyInfo.cs ]) diff --git a/src/AssemblyInfo.cs.in b/src/AssemblyInfo.cs.in new file mode 100644 index 0000000..571a80b --- /dev/null +++ b/src/AssemblyInfo.cs.in @@ -0,0 +1,39 @@ +/* -*- Mode: csharp; tab-width: 4; c-basic-offset: 4; indent-tabs-mode: t -*- */ +/*************************************************************************** + * AssemblyInfo.cs + * + * Copyright (C) 2005 Novell + * Written by Aaron Bockover (aaron@aaronbock.net) + ****************************************************************************/ + +/* AUTOGENERATED!! DO NOT EDIT!! */ + +/* THIS FILE IS LICENSED UNDER THE MIT LICENSE AS OUTLINED IMMEDIATELY BELOW: + * + * Permission is hereby granted, free of charge, to any person obtaining a + * copy of this software and associated documentation files (the "Software"), + * to deal in the Software without restriction, including without limitation + * the rights to use, copy, modify, merge, publish, distribute, sublicense, + * and/or sell copies of the Software, and to permit persons to whom the + * Software is furnished to do so, subject to the following conditions: + * + * The above copyright notice and this permission notice shall be included in + * all copies or substantial portions of the Software. + * + * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR + * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, + * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE + * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER + * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING + * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER + * DEALINGS IN THE SOFTWARE. + */ + +using System.Reflection; +using System.Runtime.CompilerServices; + +[assembly: AssemblyVersion("@MAJOR_VERSION@.@MINOR_VERSION@.@MICRO_VERSION@.*")] +[assembly: AssemblyTitle("njb-sharp")] +[assembly: AssemblyDescription("njb-sharp provides C# bindings to libnjb (http://libnjb.sourceforge.net)")] +[assembly: AssemblyCopyright("Copyright 2005 Novell, Inc.")] +[assembly: AssemblyCompany("Novell, Inc")] diff --git a/src/Makefile.am b/src/Makefile.am index 525757c..262088e 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -2,6 +2,9 @@ ASSEMBLY = njb-sharp.dll TESTASM = njb-test.exe INCLUDES = $(NJB_CFLAGS) +DOC_UPDATER = @MONODOCER@ -delete +DOC_ASSEMBLER = @MDASSEMBLER@ --out njb-sharp-docs --ecma + njbdir = $(prefix)/lib/njb-sharp njb_DATA = $(ASSEMBLY) njb_LTLIBRARIES = libnjbglue.la @@ -25,19 +28,42 @@ ASSEMBLY_SOURCES = \ TESTASM_SOURCES = \ $(srcdir)/NjbTest.cs +if BUILD_DOCS +docdir = $(DOCDIR) +doc_DATA = \ + njb-sharp-docs.zip \ + njb-sharp-docs.tree \ + njb-sharp-docs.source +endif + +njb_sharp_sources_in = AssemblyInfo.cs.in +njb_sharp_generated_sources = $(njb_sharp_sources_in:.in=) + all: $(ASSEMBLY) $(TESTASM) $(ASSEMBLY): $(ASSEMBLY_SOURCES) - $(MCS) $(MCS_FLAGS) -target:library -out:$@ $(ASSEMBLY_SOURCES) + $(MCS) $(MCS_FLAGS) -target:library -out:$@ $(ASSEMBLY_SOURCES) $(njb_sharp_generated_sources) $(TESTASM): $(TESTASM_SOURCES) $(MCS) $(MCS_FLAGS) -out:$@ -r:$(ASSEMBLY) $(TESTASM_SOURCES) +update-docs: $(ASSEMBLY) + $(DOC_UPDATER) -assembly:$(ASSEMBLY) -path:en + +njb-sharp-docs.zip njb-sharp-docs.tree: $(srcdir)/en/*/*.xml + $(DOC_ASSEMBLER) $(srcdir)/en + run: $(MONO) $(TESTASM) -EXTRA_DIST = $(ASSEMBLY_SOURCES) $(TESTASM_SOURCES) +EXTRA_DIST = \ + $(ASSEMBLY_SOURCES) \ + $(TESTASM_SOURCES) \ + $(srcdir)/en/*.xml \ + $(srcdir)/en/*/*.xml \ + njb-sharp-docs.source \ + AssemblyInfo.cs.in CLEANFILES = $(ASSEMBLY) $(TESTASM) -DISTCLEANFILES = Makefile.in +DISTCLEANFILES = Makefile.in njb-sharp-docs.zip njb-sharp-docs.tree diff --git a/src/en/Njb.xml b/src/en/Njb.xml new file mode 100644 index 0000000..059f295 --- /dev/null +++ b/src/en/Njb.xml @@ -0,0 +1,6 @@ + + + To be added. + To be added. + + diff --git a/src/en/Njb/Device.xml b/src/en/Njb/Device.xml new file mode 100644 index 0000000..6cc0c14 --- /dev/null +++ b/src/en/Njb/Device.xml @@ -0,0 +1,367 @@ + + + + njb-sharp + 0.1.1.26824 + + + System.Object + + + + + + Constructor + + + + + + 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.Void + + + + 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.Void + + + + To be added. + To be added. + + + + + Method + + System.Void + + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + Method + + Njb.Song[] + + + + To be added. + To be added. + To be added. + + + + + Method + + System.Void + + + + + + To be added. + To be added. + To be added. + + + + + Property + + System.IntPtr + + + To be added. + To be added. + To be added. + + + + + Property + + System.Int32 + + + To be added. + To be added. + To be added. + + + + + Property + + Njb.Discoverer + + + 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.String + + + To be added. + To be added. + To be added. + + + + + Property + + System.Int32 + + + To be added. + To be added. + To be added. + + + + + Property + + System.Boolean + + + To be added. + To be added. + To be added. + + + + + Property + + System.Boolean + + + To be added. + To be added. + To be added. + + + + + Property + + System.UInt64 + + + To be added. + To be added. + To be added. + + + + + Property + + System.UInt64 + + + To be added. + To be added. + To be added. + + + + + Property + + Njb.Revision + + + To be added. + To be added. + To be added. + + + + + Property + + Njb.Revision + + + To be added. + To be added. + To be added. + + + + + Property + + System.Byte[] + + + To be added. + To be added. + To be added. + + + + + Property + + System.String + + + To be added. + To be added. + To be added. + + + + + Property + + Njb.Song[] + + + 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. + + diff --git a/src/en/Njb/Discoverer.xml b/src/en/Njb/Discoverer.xml new file mode 100644 index 0000000..7e8b454 --- /dev/null +++ b/src/en/Njb/Discoverer.xml @@ -0,0 +1,91 @@ + + + + njb-sharp + 0.1.1.26824 + + + System.Object + + + + System.Collections.IEnumerable + + + System.IDisposable + + + + + System.Reflection.DefaultMember(MemberName="Item") + + + + + + Constructor + + + To be added. + To be added. + + + + + Method + + System.Void + + + + To be added. + To be added. + + + + + Method + + System.Collections.IEnumerator + + + + To be added. + To be added. + To be added. + + + + + Property + + System.IntPtr + + + To be added. + To be added. + To be added. + + + + + Property + + Njb.Device + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + To be added. + To be added. + + diff --git a/src/en/Njb/ForeachErrorCallback.xml b/src/en/Njb/ForeachErrorCallback.xml new file mode 100644 index 0000000..2df245c --- /dev/null +++ b/src/en/Njb/ForeachErrorCallback.xml @@ -0,0 +1,21 @@ + + + + njb-sharp + 0.1.1.26824 + + + System.Delegate + + + + + + System.Void + + + To be added. + To be added. + To be added. + + diff --git a/src/en/Njb/Global+DebugFlags.xml b/src/en/Njb/Global+DebugFlags.xml new file mode 100644 index 0000000..a073888 --- /dev/null +++ b/src/en/Njb/Global+DebugFlags.xml @@ -0,0 +1,66 @@ + + + + njb-sharp + 0.1.1.26824 + + + System.Enum + + + + + Field + + Njb.Global+DebugFlags + + + To be added. + + + + + Field + + Njb.Global+DebugFlags + + + To be added. + + + + + Field + + Njb.Global+DebugFlags + + + To be added. + + + + + Field + + Njb.Global+DebugFlags + + + To be added. + + + + + Field + + Njb.Global+DebugFlags + + + To be added. + + + + + To be added. + To be added. + + diff --git a/src/en/Njb/Global.xml b/src/en/Njb/Global.xml new file mode 100644 index 0000000..a32dc84 --- /dev/null +++ b/src/en/Njb/Global.xml @@ -0,0 +1,50 @@ + + + + njb-sharp + 0.1.1.26824 + + + System.Object + + + + + + Constructor + + + To be added. + To be added. + + + + + Property + + Njb.Global+DebugFlags + + + To be added. + To be added. + To be added. + + + + + Property + + System.Boolean + + + To be added. + To be added. + To be added. + + + + + To be added. + To be added. + + diff --git a/src/en/Njb/Revision.xml b/src/en/Njb/Revision.xml new file mode 100644 index 0000000..5fb111e --- /dev/null +++ b/src/en/Njb/Revision.xml @@ -0,0 +1,59 @@ + + + + njb-sharp + 0.1.1.26824 + + + System.Object + + + + + + Constructor + + + To be added. + To be added. + + + + + Field + + System.Byte + + + To be added. + To be added. + + + + + Field + + System.Byte + + + To be added. + To be added. + + + + + Field + + System.Byte + + + To be added. + To be added. + + + + + To be added. + To be added. + + diff --git a/src/en/Njb/Song.xml b/src/en/Njb/Song.xml new file mode 100644 index 0000000..e6a832d --- /dev/null +++ b/src/en/Njb/Song.xml @@ -0,0 +1,90 @@ + + + + njb-sharp + 0.1.1.26824 + + + System.Object + + + + System.IDisposable + + + + + + Constructor + + + To be added. + To be added. + + + + + Constructor + + + + + To be added. + To be added. + To be added. + + + + + Method + + System.Void + + + + To be added. + To be added. + + + + + Property + + System.Int32 + + + To be added. + To be added. + To be added. + + + + + Property + + System.Int32 + + + To be added. + To be added. + To be added. + + + + + Property + + Njb.SongFrame[] + + + To be added. + To be added. + To be added. + + + + + To be added. + To be added. + + diff --git a/src/en/Njb/SongFrame.xml b/src/en/Njb/SongFrame.xml new file mode 100644 index 0000000..c14bc6c --- /dev/null +++ b/src/en/Njb/SongFrame.xml @@ -0,0 +1,89 @@ + + + + njb-sharp + 0.1.1.26824 + + + System.Object + + + + + + Constructor + + + + + To be added. + To be added. + To be added. + + + + + Property + + System.String + + + To be added. + To be added. + To be added. + + + + + Property + + Njb.SongFrameType + + + To be added. + To be added. + To be added. + + + + + Property + + System.String + + + To be added. + To be added. + To be added. + + + + + Property + + System.UInt16 + + + To be added. + To be added. + To be added. + + + + + Property + + System.UInt32 + + + To be added. + To be added. + To be added. + + + + + To be added. + To be added. + + diff --git a/src/en/Njb/SongFrameType.xml b/src/en/Njb/SongFrameType.xml new file mode 100644 index 0000000..397091a --- /dev/null +++ b/src/en/Njb/SongFrameType.xml @@ -0,0 +1,46 @@ + + + + njb-sharp + 0.1.1.26824 + + + System.Enum + + + + + Field + + Njb.SongFrameType + + + To be added. + + + + + Field + + Njb.SongFrameType + + + To be added. + + + + + Field + + Njb.SongFrameType + + + To be added. + + + + + To be added. + To be added. + + diff --git a/src/en/index.xml b/src/en/index.xml new file mode 100644 index 0000000..f2c3cfb --- /dev/null +++ b/src/en/index.xml @@ -0,0 +1,36 @@ + + + + + + System.Reflection.AssemblyCompany(Company="Novell, Inc") + + + System.Reflection.AssemblyCopyright(Copyright="Copyright 2005 Novell, Inc.") + + + System.Reflection.AssemblyDescription(Description="njb-sharp provides C# bindings to libnjb (http://libnjb.sourceforge.net)") + + + System.Reflection.AssemblyTitle(Title="njb-sharp") + + + + + njb-sharp provides C# bindings to libnjb (http://libnjb.sourceforge.net) + Copyright 2005 Novell, Inc." + + + + + + + + + + + + + + njb-sharp + diff --git a/src/njb-sharp-docs.source b/src/njb-sharp-docs.source new file mode 100644 index 0000000..99bb080 --- /dev/null +++ b/src/njb-sharp-docs.source @@ -0,0 +1,5 @@ + + + + +