X Tutup
Skip to content

Commit bd73d5a

Browse files
vmuriartvmuriart
committed
XML Docs on test fixtures
1 parent 3058bf7 commit bd73d5a

18 files changed

+71
-86
lines changed

‎src/testing/arraytest.cs‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
namespace Python.Test
22
{
3-
//========================================================================
4-
// Supports units tests for indexer access.
5-
//========================================================================
6-
3+
/// <summary>
4+
/// Supports units tests for indexer access.
5+
/// </summary>
76
public class PublicArrayTest
87
{
98
public int[] items;

‎src/testing/callbacktest.cs‎

Lines changed: 8 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22

33
namespace Python.Test
44
{
5-
//========================================================================
6-
// Tests callbacks into python code.
7-
//========================================================================
8-
5+
/// <summary>
6+
/// Tests callbacks into python code.
7+
/// </summary>
98
public class CallbackTest
109
{
1110
public string Call_simpleDefaultArg_WithNull(string moduleName)
@@ -27,11 +26,11 @@ public string Call_simpleDefaultArg_WithEmptyArgs(string moduleName)
2726
}
2827
}
2928

30-
//==========================================================================
31-
// Tests calling from Python into C# and back into Python using a PyObject.
32-
// SelfCallbackTest should be inherited by a Python class.
33-
// Used in test_class.py / testCallback
34-
//==========================================================================
29+
/// <summary>
30+
/// Tests calling from Python into C# and back into Python using a PyObject.
31+
/// SelfCallbackTest should be inherited by a Python class.
32+
/// Used in test_class.py / testCallback
33+
/// </summary>
3534
public class SelfCallbackTest
3635
{
3736
public void Callback(PyObject self)

‎src/testing/classtest.cs‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22

33
namespace Python.Test
44
{
5-
//========================================================================
6-
// Supports CLR class unit tests.
7-
//========================================================================
8-
5+
/// <summary>
6+
/// Supports CLR class unit tests.
7+
/// </summary>
98
public class ClassTest
109
{
1110
public static ArrayList GetArrayList()

‎src/testing/constructortests.cs‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,10 +3,9 @@
33

44
namespace Python.Test
55
{
6-
//========================================================================
7-
// These classes support the CLR constructor unit tests.
8-
//========================================================================
9-
6+
/// <summary>
7+
/// These classes support the CLR constructor unit tests.
8+
/// </summary>
109
public class EnumConstructorTest
1110
{
1211
public TypeCode value;

‎src/testing/conversiontest.cs‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
namespace Python.Test
22
{
3-
//========================================================================
4-
// Supports units tests for field access.
5-
//========================================================================
6-
3+
/// <summary>
4+
/// Supports units tests for field access.
5+
/// </summary>
76
public class ConversionTest
87
{
98
public ConversionTest()

‎src/testing/delegatetest.cs‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,8 @@
11
namespace Python.Test
22
{
3-
//========================================================================
4-
// Supports CLR class unit tests.
5-
//========================================================================
6-
3+
/// <summary>
4+
/// Supports CLR class unit tests.
5+
/// </summary>
76
public delegate void PublicDelegate();
87

98
internal delegate void InternalDelegate();

‎src/testing/doctest.cs‎

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -2,12 +2,13 @@
22

33
namespace Python.Test
44
{
5-
//========================================================================
6-
// Supports units tests for exposing docstrings from C# to Python
7-
//========================================================================
8-
9-
// Classes with a constructor have their docstring set to the ctor signature.
10-
// Test if a class has an explicit doc string it gets set correctly.
5+
/// <summary>
6+
/// Supports units tests for exposing docstrings from C# to Python
7+
/// </summary>
8+
/// <remarks>
9+
/// Classes with a constructor have their docstring set to the ctor signature.
10+
/// Test if a class has an explicit doc string it gets set correctly.
11+
/// </remarks>
1112
[DocString("DocWithCtorTest Class")]
1213
public class DocWithCtorTest
1314
{

‎src/testing/enumtest.cs‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22

33
namespace Python.Test
44
{
5-
//========================================================================
6-
// Supports CLR enum unit tests.
7-
//========================================================================
8-
5+
/// <summary>
6+
/// Supports CLR enum unit tests.
7+
/// </summary>
98
public enum ByteEnum : byte
109
{
1110
Zero,

‎src/testing/eventtest.cs‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22

33
namespace Python.Test
44
{
5-
//========================================================================
6-
// Supports CLR event unit tests.
7-
//========================================================================
8-
5+
/// <summary>
6+
/// Supports CLR event unit tests.
7+
/// </summary>
98
public delegate void EventHandlerTest(object sender, EventArgsTest e);
109

1110

‎src/testing/exceptiontest.cs‎

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -2,10 +2,9 @@
22

33
namespace Python.Test
44
{
5-
//========================================================================
6-
// Supports CLR Exception unit tests.
7-
//========================================================================
8-
5+
/// <summary>
6+
/// Supports CLR Exception unit tests.
7+
/// </summary>
98
public class ExceptionTest
109
{
1110
public int ThrowProperty

0 commit comments

Comments
 (0)
X Tutup