mono
/
njb-sharp
зеркало из https://github.com/mono/njb-sharp.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность

Add documentation 

svn path=/trunk/njb-sharp/; revision=51631
This commit is contained in:
Aaron Bockover 2005-10-11 19:17:32 +00:00
Родитель c179d6796a
Коммит 971d0cad69
15 изменённых файлов: 1021 добавлений и 7 удалений
Показать статистику Скачать Patch файл Скачать Diff файл Показать все файлы Свернуть все файлы

31
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
])

39
src/AssemblyInfo.cs.in Normal file
Просмотреть файл

@ -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")]

32
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

6
src/en/Njb.xml Normal file
Просмотреть файл

@ -0,0 +1,6 @@
<Namespace Name="Njb">
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Namespace>

367
src/en/Njb/Device.xml Normal file
Просмотреть файл

@ -0,0 +1,367 @@
<Type Name="Device" FullName="Njb.Device">
<TypeSignature Language="C#" Value="public class Device" />
<AssemblyInfo>
<AssemblyName>njb-sharp</AssemblyName>
<AssemblyVersion>0.1.1.26824</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Device (Njb.Discoverer discoverer, int index);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="discoverer" Type="Njb.Discoverer" />
<Parameter Name="index" Type="System.Int32" />
</Parameters>
<Docs>
<param name="discoverer">To be added.</param>
<param name="index">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Open">
<MemberSignature Language="C#" Value="public bool Open ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<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="Capture">
<MemberSignature Language="C#" Value="public bool Capture ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Release">
<MemberSignature Language="C#" Value="public bool Release ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Ping">
<MemberSignature Language="C#" Value="public void Ping ();" />
<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="GetDiskUsage">
<MemberSignature Language="C#" Value="public void GetDiskUsage (out ulong bytesTotal, out ulong bytesFree);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="bytesTotal" Type="System.UInt64&amp;" RefType="out" />
<Parameter Name="bytesFree" Type="System.UInt64&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="bytesTotal">To be added.</param>
<param name="bytesFree">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ReloadSongs">
<MemberSignature Language="C#" Value="public Njb.Song[] ReloadSongs ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Njb.Song[]</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ForeachError">
<MemberSignature Language="C#" Value="public void ForeachError (Njb.ForeachErrorCallback callback);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="callback" Type="Njb.ForeachErrorCallback" />
</Parameters>
<Docs>
<param name="callback">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Handle">
<MemberSignature Language="C#" Value="public IntPtr Handle { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.IntPtr</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Index">
<MemberSignature Language="C#" Value="public int Index { 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="Discoverer">
<MemberSignature Language="C#" Value="public Njb.Discoverer Discoverer { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Njb.Discoverer</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public string Name { 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="UsbName">
<MemberSignature Language="C#" Value="public string UsbName { 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="Owner">
<MemberSignature Language="C#" Value="public string Owner { 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="BatteryLevel">
<MemberSignature Language="C#" Value="public int BatteryLevel { 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="BatteryCharging">
<MemberSignature Language="C#" Value="public bool BatteryCharging { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="AuxilaryPower">
<MemberSignature Language="C#" Value="public bool AuxilaryPower { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DiskFree">
<MemberSignature Language="C#" Value="public ulong DiskFree { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt64</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DiskTotal">
<MemberSignature Language="C#" Value="public ulong DiskTotal { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt64</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="FirmwareRevision">
<MemberSignature Language="C#" Value="public Njb.Revision FirmwareRevision { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Njb.Revision</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="HardwareRevision">
<MemberSignature Language="C#" Value="public Njb.Revision HardwareRevision { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Njb.Revision</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SdmiId">
<MemberSignature Language="C#" Value="public byte[] SdmiId { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Byte[]</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="SdmiIdString">
<MemberSignature Language="C#" Value="public string SdmiIdString { 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="Songs">
<MemberSignature Language="C#" Value="public Njb.Song[] Songs { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Njb.Song[]</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="NextError">
<MemberSignature Language="C#" Value="public string NextError { 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="IsErrorPending">
<MemberSignature Language="C#" Value="public bool IsErrorPending { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ErrorsPending">
<MemberSignature Language="C#" Value="public string[] ErrorsPending { 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>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Type>

91
src/en/Njb/Discoverer.xml Normal file
Просмотреть файл

@ -0,0 +1,91 @@
<Type Name="Discoverer" FullName="Njb.Discoverer">
<TypeSignature Language="C#" Value="public class Discoverer : System.Collections.IEnumerable, System.IDisposable" />
<AssemblyInfo>
<AssemblyName>njb-sharp</AssemblyName>
<AssemblyVersion>0.1.1.26824</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.Collections.IEnumerable</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes>
<Attribute>
<AttributeName>System.Reflection.DefaultMember(MemberName="Item")</AttributeName>
</Attribute>
</Attributes>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Discoverer ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="public void Dispose ();" />
<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="GetEnumerator">
<MemberSignature Language="C#" Value="public System.Collections.IEnumerator GetEnumerator ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Collections.IEnumerator</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="ArrayHandle">
<MemberSignature Language="C#" Value="public IntPtr ArrayHandle { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.IntPtr</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Item">
<MemberSignature Language="C#" Value="public Njb.Device Item[int i] { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Njb.Device</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="i" Type="System.Int32" />
</Parameters>
<Docs>
<param name="i">To be added.</param>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Type>

21
src/en/Njb/ForeachErrorCallback.xml Normal file
Просмотреть файл

@ -0,0 +1,21 @@
<Type Name="ForeachErrorCallback" FullName="Njb.ForeachErrorCallback">
<TypeSignature Language="C#" Value="public delegate void ForeachErrorCallback(string error);" />
<AssemblyInfo>
<AssemblyName>njb-sharp</AssemblyName>
<AssemblyVersion>0.1.1.26824</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>
</Base>
<Parameters>
<Parameter Name="error" Type="System.String" />
</Parameters>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Docs>
<param name="error">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Type>

66
src/en/Njb/Global+DebugFlags.xml Normal file
Просмотреть файл

@ -0,0 +1,66 @@
<Type Name="Global+DebugFlags" FullName="Njb.Global+DebugFlags">
<TypeSignature Language="C#" Value="public enum DebugFlags" />
<AssemblyInfo>
<AssemblyName>njb-sharp</AssemblyName>
<AssemblyVersion>0.1.1.26824</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Members>
<Member MemberName="SUBTRACE">
<MemberSignature Language="C#" Value="SUBTRACE" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Njb.Global+DebugFlags</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
</Docs>
</Member>
<Member MemberName="USBCTL">
<MemberSignature Language="C#" Value="USBCTL" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Njb.Global+DebugFlags</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
</Docs>
</Member>
<Member MemberName="USBBLKLIM">
<MemberSignature Language="C#" Value="USBBLKLIM" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Njb.Global+DebugFlags</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
</Docs>
</Member>
<Member MemberName="USBBLK">
<MemberSignature Language="C#" Value="USBBLK" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Njb.Global+DebugFlags</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
</Docs>
</Member>
<Member MemberName="ALL">
<MemberSignature Language="C#" Value="ALL" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Njb.Global+DebugFlags</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
</Docs>
</Member>
</Members>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Type>

50
src/en/Njb/Global.xml Normal file
Просмотреть файл

@ -0,0 +1,50 @@
<Type Name="Global" FullName="Njb.Global">
<TypeSignature Language="C#" Value="public class Global" />
<AssemblyInfo>
<AssemblyName>njb-sharp</AssemblyName>
<AssemblyVersion>0.1.1.26824</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Global ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Debug">
<MemberSignature Language="C#" Value="public static Njb.Global+DebugFlags Debug { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Njb.Global+DebugFlags</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Unicode">
<MemberSignature Language="C#" Value="public static bool Unicode { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Type>

59
src/en/Njb/Revision.xml Normal file
Просмотреть файл

@ -0,0 +1,59 @@
<Type Name="Revision" FullName="Njb.Revision">
<TypeSignature Language="C#" Value="public class Revision" />
<AssemblyInfo>
<AssemblyName>njb-sharp</AssemblyName>
<AssemblyVersion>0.1.1.26824</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Revision ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Major">
<MemberSignature Language="C#" Value="public byte Major;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Byte</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Minor">
<MemberSignature Language="C#" Value="public byte Minor;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Byte</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Release">
<MemberSignature Language="C#" Value="public byte Release;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Byte</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Type>

90
src/en/Njb/Song.xml Normal file
Просмотреть файл

@ -0,0 +1,90 @@
<Type Name="Song" FullName="Njb.Song">
<TypeSignature Language="C#" Value="public class Song : System.IDisposable" />
<AssemblyInfo>
<AssemblyName>njb-sharp</AssemblyName>
<AssemblyVersion>0.1.1.26824</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Song ();" />
<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 Song (IntPtr songidPtr);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="songidPtr" Type="System.IntPtr" />
</Parameters>
<Docs>
<param name="songidPtr">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="public void Dispose ();" />
<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="Id">
<MemberSignature Language="C#" Value="public int Id { 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="FrameCount">
<MemberSignature Language="C#" Value="public int FrameCount { 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="Frames">
<MemberSignature Language="C#" Value="public Njb.SongFrame[] Frames { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Njb.SongFrame[]</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Type>

89
src/en/Njb/SongFrame.xml Normal file
Просмотреть файл

@ -0,0 +1,89 @@
<Type Name="SongFrame" FullName="Njb.SongFrame">
<TypeSignature Language="C#" Value="public class SongFrame" />
<AssemblyInfo>
<AssemblyName>njb-sharp</AssemblyName>
<AssemblyVersion>0.1.1.26824</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public SongFrame (IntPtr framePtr);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="framePtr" Type="System.IntPtr" />
</Parameters>
<Docs>
<param name="framePtr">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Label">
<MemberSignature Language="C#" Value="public string Label { 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="FrameType">
<MemberSignature Language="C#" Value="public Njb.SongFrameType FrameType { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Njb.SongFrameType</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DataString">
<MemberSignature Language="C#" Value="public string DataString { 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="DataShort">
<MemberSignature Language="C#" Value="public ushort DataShort { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt16</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="DataInt">
<MemberSignature Language="C#" Value="public uint DataInt { 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>
</Members>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Type>

46
src/en/Njb/SongFrameType.xml Normal file
Просмотреть файл

@ -0,0 +1,46 @@
<Type Name="SongFrameType" FullName="Njb.SongFrameType">
<TypeSignature Language="C#" Value="public enum SongFrameType" />
<AssemblyInfo>
<AssemblyName>njb-sharp</AssemblyName>
<AssemblyVersion>0.1.1.26824</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
</Base>
<Members>
<Member MemberName="UInt32">
<MemberSignature Language="C#" Value="UInt32" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Njb.SongFrameType</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
</Docs>
</Member>
<Member MemberName="String">
<MemberSignature Language="C#" Value="String" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Njb.SongFrameType</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
</Docs>
</Member>
<Member MemberName="UInt16">
<MemberSignature Language="C#" Value="UInt16" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>Njb.SongFrameType</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
</Docs>
</Member>
</Members>
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Type>

36
src/en/index.xml Normal file
Просмотреть файл

@ -0,0 +1,36 @@
<Overview>
<Assemblies>
<Assembly Name="njb-sharp" Version="0.1.1.26824">
<Attributes>
<Attribute>
<AttributeName>System.Reflection.AssemblyCompany(Company="Novell, Inc")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Reflection.AssemblyCopyright(Copyright="Copyright 2005 Novell, Inc.")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Reflection.AssemblyDescription(Description="njb-sharp provides C# bindings to libnjb (http://libnjb.sourceforge.net)")</AttributeName>
</Attribute>
<Attribute>
<AttributeName>System.Reflection.AssemblyTitle(Title="njb-sharp")</AttributeName>
</Attribute>
</Attributes>
</Assembly>
</Assemblies>
<Remarks>njb-sharp provides C# bindings to libnjb (http://libnjb.sourceforge.net)</Remarks>
<Copyright>Copyright 2005 Novell, Inc."</Copyright>
<Types>
<Namespace Name="Njb">
<Type Name="Discoverer" />
<Type Name="Device" />
<Type Name="Song" />
<Type Name="SongFrame" />
<Type Name="Global" />
<Type Name="Global+DebugFlags" />
<Type Name="Revision" />
<Type Name="ForeachErrorCallback" />
<Type Name="SongFrameType" />
</Namespace>
</Types>
<Title>njb-sharp</Title>
</Overview>

5
src/njb-sharp-docs.source Normal file
Просмотреть файл

@ -0,0 +1,5 @@
<?xml version="1.0"?>
<monodoc>
<source provider="ecma" basefile="njb-sharp-docs" path="various" />
</monodoc>