C:\Program Files\VSdocman C:\TestDLL\VSdoc C:\Program Files\VSdocman\Templates TestDLL

topic_000000000000000E

Overview TestDLL Usage Basic Functionality Advanced TestDLL Reference TestDLL Namespace License Agreement About

Overview Overview Overview topic_000000000000000E

This is documentation for our sample TestDLL class library. It was generated with VSdocman to show its capabilities. With VSdocman you can comment and generate documentation for your .NET code.

This topic and other topics and chapters were created as custom topics. The API topics in TestDLL Reference chapter were generated from the source code and XML comments. See the API documentation for the main DllClass1 class.

TestDLL Usage TestDLL Usage TestDLL Usage topic_000000000000000F

Basic Functionality Basic Functionality Basic Functionality topic_0000000000000010

Here we describe basic functionality of TestDLL library.

Advanced Usage Advanced Advanced Advanced topic_0000000000000011

To fully use the TestDLL, you need to understand some additional concepts. They are described below.

Our remarks here. Basic Functionality TestDLL Reference TestDLL Reference TestDLL Reference topic_0000000000000012

Here you can find class reference for TestDLL. See the API documentation for its main TestDLL namespace.

TestDLL TestDLL TestDLL TestDLL (in TestDLL.dll) topic_0000000000000014

This is main namespace.

You can navigate to code elements using clickable class diagram below. The diagram can be placed anywhere, e.g. in summary or Remarks section or in its own section as shown here.

DllClass1 DllModule1 DllClass1 DllClass1 TestDLL.DllClass1 TestDLL (in TestDLL.dll) topic_0000000000000000

The main class of TestDll.

Here we show how to use XML comments.

Public Class DllClass1 Implements IEnumerable(Of String)

public class DllClass1 : IEnumerable<string>

public __gc class DllClass1 : public IEnumerable<String>

JScript does not support generic types and methods.

GetEnumerator GetEnumerator1 method1 method1(Of T) prop1 prop2 nestedException DllClass1.prop1 prop1 TestDLL.DllClass1.prop1 TestDLL (in TestDLL.dll) topic_0000000000000007

Our sample property.

This property is really interesting. We can use: font formatting or codebulleted or numbered liststables, pictures, links Here is the table: Column1Column2abc def This is an example how to use prop1 and prop2 properties:

  Try     If Me.prop1 <> "hello" Then         prop2 = DllModule1.sampleEnum.value2     End If Catch ex As nestedException     prop2 = DllModule1.sampleEnum.value1 End Try

Public Property prop1() As String

public string prop1 {get; set;}

public: String __gc* get_prop1()public: void set_prop1( String __gc*)

public function get prop1() : String;public function set prop1(value : String);

    Property prop1() As String        Get            Return "Hello"        End Get        Set(ByVal Value As String)        End Set    End Property

Another interesting property DllClass1.prop2 prop2 TestDLL.DllClass1.prop2 TestDLL (in TestDLL.dll) topic_0000000000000008

Our second sample property.

Only allowed values. Only allowed values.

Friend Property prop2() As sampleEnum

internal sampleEnum prop2 {get; set;}

public private: sampleEnum get_prop2()public private: void set_prop2( sampleEnum)

internal function get prop2() : sampleEnum;internal function set prop2(value : sampleEnum);

Our Property 1 TestDLL.DllModule1.sampleEnum DllClass1.GetEnumerator GetEnumerator TestDLL.DllClass1.GetEnumerator TestDLL (in TestDLL.dll) topic_0000000000000001

Returns an enumerator that iterates through the collection.

A IEnumerator<T> that can be used to iterate through the collection.

Public Function GetEnumerator() As IEnumerator(Of String)

public IEnumerator<string> GetEnumerator();

public: IEnumerator<String> __gc* GetEnumerator();

JScript does not support generic types and methods.

DllClass1.GetEnumerator1 GetEnumerator1 TestDLL.DllClass1.GetEnumerator1 TestDLL (in TestDLL.dll) topic_0000000000000002

Returns an enumerator that iterates through a collection.

An IEnumerator object that can be used to iterate through the collection.

Public Function GetEnumerator1() As IEnumerator Implements _ System.Collections.IEnumerable.GetEnumerator

public IEnumerator GetEnumerator1();

public: IEnumerator __gc* GetEnumerator1();

public function GetEnumerator1() : IEnumerator;

DllClass1.method1 (System.String) method1 TestDLL.DllClass1.method1 TestDLL (in TestDLL.dll) topic_0000000000000004

Sample method with one String argument.

This remarks section was included from external XML file using <include> comment tag. True if no error occurs. The first parameter. Public Function method1( _ ByVal x As String _) As Boolean

public bool method1( string x);

public: bool method1( String __gc* x);

public function method1( x : String) : boolean;

DllClass1.method1 (System.Int32) method1 TestDLL.DllClass1.method1 TestDLL (in TestDLL.dll) topic_0000000000000003

Our sample method.

True if no error occurs. The first parameter. Public Function method1( _ ByVal x As Integer _) As Boolean

public bool method1( int x);

public: bool method1( int x);

public function method1( x : int) : boolean;

DllClass1.method1(Of T) method1(Of T) TestDLL.DllClass1.method1(Of T) TestDLL (in TestDLL.dll) topic_0000000000000005

Sample method with two arguments.

True if no error occurs. The type used in this generic method. The first parameter. The second parameter. If something horrible happens.

Public Function method1(Of _ T)( _ ByVal x As Integer(), _ ByVal y As String _) As Boolean

public bool method1<T>( int[] x, string y);

generic<typename T>public: bool method1( int x __gc[], String __gc* y);

JScript does not support generic types and methods.

nestedException nestedException TestDLL.DllClass1.nestedException TestDLL (in TestDLL.dll) topic_0000000000000006

This is our custom exception.

This is also an example of nested class.

<AttributeUsage(AttributeTargets.Class, AllowMultiple:=True)> _Public Class nestedException Inherits Exception

[AttributeUsage(AttributeTargets.Class, AllowMultiple:=True)]public class nestedException : Exception

[AttributeUsage(AttributeTargets.Class, AllowMultiple:=True)]public __gc class nestedException : public Exception

public AttributeUsage(AttributeTargets.Class, AllowMultiple:=True)class nestedException extends Exception

DllModule1 DllModule1 TestDLL.DllModule1 TestDLL (in TestDLL.dll) topic_0000000000000009

Friend Module DllModule1

internal sealed class DllModule1

private __sealed __gc class DllModule1

internal final class DllModule1

sampleEnum sampleEnum sampleEnum TestDLL.DllModule1.sampleEnum TestDLL (in TestDLL.dll) topic_000000000000000A

Sample enumeration.

To see the values of enumerations in documentation you must check to compile also constants in VSdocman options. First value. Second value Third value. License Agreement License Agreement License Agreement topic_0000000000000015

The license agreement.

About About About topic_0000000000000016

TestDLL version 1.0