DC2343A  FW 1.0.2 / GUI 1.0.10
LTC3335 Nanopower Buck-Boost DC/DC with Integrated Coulomb Counter
 All Data Structures Namespaces Files Functions Variables Enumerations Enumerator Properties Groups Pages
class_with_interface.vb
Go to the documentation of this file.
1 /**
2  * @file class_with_interface.vb
3  * <summary>example file demonstrating interfaces and classes</summary>
4  * <remarks>detailed file description comes here<BR><BR>
5  * The original unfiltered source of this file : <A HREF="http://trac.sevo.org/projects/doxyvb/browser/trunk/samples/DotNET/class_with_interface.vb">class_with_interface.vb</A></remarks>
6  */
7 using System.IO;
8 using System.Threading;
9 using System.Runtime.Serialization;
10 /**
11  * <summary>
12  * simple enumeration
13  * </summary>
14  * <remarks>description of the simple enumeration</remarks>
15  */
16 public enum SampleEnum
17 {
18  Value1, /**< \brief first value */
19  /**
20  * <summary>
21  * second value
22  * </summary>
23  */
24  Value2,
25  Value3 = 1234, /**< \brief third assigned value */
26  Value4 /**< \brief fourth value */
27 }
28 /**
29  * <summary>
30  * sample interface
31  * </summary>
32  * <remarks>interface inherits IDisposable</remarks>
33  */
34 public interface ISample
35 : IDisposable
36 {
37  /**
38  * <summary>
39  * simple property
40  * </summary>
41  * <value>returns a string value</value>
42  */
43  string StringProperty
44  { get; set; }
45  /**
46  * <summary>
47  * read only property
48  * </summary>
49  * <value>returns an Integer value</value>
50  */
51  int IntegerProperty
52  { get; }
53  /**
54  * <summary>
55  * simple method
56  * </summary>
57  * <remarks>no remarks</remarks>
58  */
59  void SampleMethod();
60  /**
61  * <summary>
62  * simple method with parameters
63  * </summary>
64  * <param name="pFirst">first parameter is a String</param>
65  * <param name="pPointer">second parameter is a pointer to an Integer</param>
66  * <remarks></remarks>
67  */
68  void SampleMethodWithParams (string pFirst, ref int pPointer) ;
69  /**
70  * <summary>
71  * simple function with a parameter
72  * </summary>
73  * <param name="pFirst">Double parameter</param>
74  * <returns>a Double value</returns>
75  * <remarks></remarks>
76  */
77  double SampleFunction (double pFirst) ;
78  /**
79  * <summary>
80  * simple event with a parameter
81  * </summary>
82  * <param name="Sender">event sender object</param>
83  */
84  event OnSomeEvent (object Sender) ;
85 }
86 /**
87  * <summary>
88  * simple class implementing an interface
89  * </summary>
90  * <remarks>Implements ISample</remarks>
91  */
92 public class SampleClass
93 : ISample
94 {
95  /**
96  * <summary>
97  * nested class declared inside SampleClass
98  * </summary>
99  */
100  public class NestedClass
101  : object
102  {
103  public string someString ; /**< \brief simple public string value */
104  /**
105  * <summary>
106  * some event
107  * </summary>
108  * <param name="Sender">sender of object type</param>
109  * <param name="args">event arguments</param>
110  * <remarks></remarks>
111  */
112  public event SomeEvent (object Sender, EventArgs args) ;
113  }
114  private int someInteger ; /**< \brief simple private integer value */
115  public long[] longArray ; /**< \brief long array */
116  public string someString ; /**< \brief simple public string value */
117  public NestedClass nestedClassObject ; /**< \brief NestedClass instance */
118  /**
119  * <summary>
120  * simple property
121  * </summary>
122  * <value>some string</value>
123  * <returns>some string</returns>
124  */
125  public string StringProperty /** Implements <see cref="ISample.StringProperty "/> */
126  { get; set; }
127  /**
128  * <summary>
129  * readonly property
130  * </summary>
131  * <value>integer value</value>
132  * <returns>same interger value</returns>
133  */
134  public int IntegerProperty /** Implements <see cref="ISample.IntegerProperty "/> */
135  { get; }
136  /**
137  * <summary>
138  * function with parameter
139  * </summary>
140  * <param name="pFirst">simple parameter</param>
141  * <returns>some double value</returns>
142  * <remarks></remarks>
143  */
144  public double SampleFunction (double pFirst) ; /**< Implements <see cref="ISample.SampleFunction "/> */
145  /**
146  * <summary>
147  * function with arrays
148  * </summary>
149  * <param name="pFirst">double array as parameter</param>
150  * <returns>double array</returns>
151  * <remarks></remarks>
152  */
153  public double[] SampleFunction2 (double[] pFirst) ;
154  /**
155  * <summary>
156  * simple operator
157  * </summary>
158  * <param name="Obj1">first simple object</param>
159  * <param name="Obj2">second simple object</param>
160  * <returns>True if Obj1 equal to, or bigger than Obj2</returns>
161  */
162  public static bool operator + (SampleClass Obj1, SampleClass Obj2) ;
163  /**
164  * <summary>
165  * shared/static function
166  * </summary>
167  * <returns>a String value</returns>
168  */
169  static string SampleFunction () ;
170  /**
171  * <summary>
172  * simple method
173  * </summary>
174  * <remarks></remarks>
175  */
176  public void SampleMethod() ; /**< Implements <see cref="ISample.SampleMethod"/> */
177  /**
178  * <summary>
179  * method with parameters
180  * </summary>
181  * <param name="pFirst">simple param</param>
182  * <param name="pPointer">pinter</param>
183  * <remarks></remarks>
184  */
185  public void SampleMethodWithParams (string pFirst, ref int pPointer) ; /**< Implements <see cref="ISample.SampleMethodWithParams "/> */
186  /**
187  * <summary>
188  * method with an array as param
189  * </summary>
190  * <param name="pArr">integer array</param>
191  * <param name="pArg">simple parameter</param>
192  * <remarks></remarks>
193  */
194  public void MethodWithArrayParams (int[] pArr, int pArg) ;
195  /**
196  * <summary>
197  * method handles event from nested class
198  * </summary>
199  */
200  /// \remark Handles the nestedClassObject.SomeEvent event.
201  public void nestedClassObject_OnSomeEvent (object Sender, EventArgs args);
202  /**
203  * <summary>
204  * some event
205  * </summary>
206  * <param name="Sender">sender of object type</param>
207  * <remarks></remarks>
208  */
209  public event OnSomeEvent (object Sender) ; /**< Implements <see cref="ISample.OnSomeEvent "/> */
210  private bool disposedValue = False ; /**< \brief generated by VS class designer */
211  /**
212  * <summary>
213  * IDisposable implementation
214  * </summary>
215  * <param name="disposing"></param>
216  * <remarks>Is called from default Dispose method.</remarks>
217  */
218  protected virtual void Dispose (bool disposing) ;
219  /**
220  * <summary>
221  * IDisposable implementation
222  * </summary>
223  * <remarks></remarks>
224  */
225  public void Dispose() ; /**< Implements <see cref="IDisposable.Dispose"/> */
226 }
void MethodWithArrayParams(int[] pArr, int pArg)
method with an array as param
OnSomeEvent(object Sender)
simple event with a parameter
SomeEvent(object Sender, EventArgs args)
some event
long[] longArray
long array
static bool operator+(SampleClass Obj1, SampleClass Obj2)
simple operator
simple class implementing an interface
fourth value
first value
nested class declared inside SampleClass
NestedClass nestedClassObject
NestedClass instance.
double SampleFunction(double pFirst)
simple function with a parameter
SampleEnum
simple enumeration
void SampleMethod()
simple method
string StringProperty
simple property
void Dispose()
IDisposable implementation
void SampleMethodWithParams(string pFirst, ref int pPointer)
method with parameters
string someString
simple public string value
int IntegerProperty
readonly property
void SampleMethod()
simple method
double[] SampleFunction2(double[] pFirst)
function with arrays
sample interface
void SampleMethodWithParams(string pFirst, ref int pPointer)
simple method with parameters
third assigned value
OnSomeEvent(object Sender)
some event
string StringProperty
simple property
string someString
simple public string value
second value
void nestedClassObject_OnSomeEvent(object Sender, EventArgs args)
method handles event from nested class
int IntegerProperty
read only property