Skip to content

Commit

Permalink
added xmldocs
Browse files Browse the repository at this point in the history
  • Loading branch information
dandraka committed Apr 25, 2024
1 parent ed3374b commit 414e943
Show file tree
Hide file tree
Showing 49 changed files with 730 additions and 0 deletions.
21 changes: 21 additions & 0 deletions docs/Dandraka.Zoro.Processor/CharExtension.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
# CharExtension class

```csharp
public static class CharExtension
```

## Public Members

| name | description |
| --- | --- |
| static [GetRandomConsonant](CharExtension/GetRandomConsonant.md)() | |
| static [GetRandomVowel](CharExtension/GetRandomVowel.md)() | |
| static [IsConsonant](CharExtension/IsConsonant.md)(…) | |
| static [IsVowel](CharExtension/IsVowel.md)(…) | |

## See Also

* namespace [Dandraka.Zoro.Processor](../Dandraka.Zoro.ProcessorNamespace.md.md)
* assembly [Zoro.Processor](../Zoro.Processor.md)

<!-- DO NOT EDIT: generated by xmldocmd for Zoro.Processor.dll -->
13 changes: 13 additions & 0 deletions docs/Dandraka.Zoro.Processor/CharExtension/GetRandomConsonant.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# CharExtension.GetRandomConsonant method

```csharp
public static char GetRandomConsonant()
```

## See Also

* class [CharExtension](../CharExtension.md)
* namespace [Dandraka.Zoro.Processor](../CharExtension.md.md)
* assembly [Zoro.Processor](../../Zoro.Processor.md)

<!-- DO NOT EDIT: generated by xmldocmd for Zoro.Processor.dll -->
13 changes: 13 additions & 0 deletions docs/Dandraka.Zoro.Processor/CharExtension/GetRandomVowel.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# CharExtension.GetRandomVowel method

```csharp
public static char GetRandomVowel()
```

## See Also

* class [CharExtension](../CharExtension.md)
* namespace [Dandraka.Zoro.Processor](../CharExtension.md.md)
* assembly [Zoro.Processor](../../Zoro.Processor.md)

<!-- DO NOT EDIT: generated by xmldocmd for Zoro.Processor.dll -->
13 changes: 13 additions & 0 deletions docs/Dandraka.Zoro.Processor/CharExtension/IsConsonant.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# CharExtension.IsConsonant method

```csharp
public static bool IsConsonant(this char c)
```

## See Also

* class [CharExtension](../CharExtension.md)
* namespace [Dandraka.Zoro.Processor](../CharExtension.md.md)
* assembly [Zoro.Processor](../../Zoro.Processor.md)

<!-- DO NOT EDIT: generated by xmldocmd for Zoro.Processor.dll -->
13 changes: 13 additions & 0 deletions docs/Dandraka.Zoro.Processor/CharExtension/IsVowel.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# CharExtension.IsVowel method

```csharp
public static bool IsVowel(this char c)
```

## See Also

* class [CharExtension](../CharExtension.md)
* namespace [Dandraka.Zoro.Processor](../CharExtension.md.md)
* assembly [Zoro.Processor](../../Zoro.Processor.md)

<!-- DO NOT EDIT: generated by xmldocmd for Zoro.Processor.dll -->
20 changes: 20 additions & 0 deletions docs/Dandraka.Zoro.Processor/DataDestination.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# DataDestination enumeration

```csharp
public enum DataDestination
```

## Values

| name | value | description |
| --- | --- | --- |
| CsvFile | `0` | |
| Database | `1` | |
| JsonFile | `2` | |

## See Also

* namespace [Dandraka.Zoro.Processor](../Dandraka.Zoro.ProcessorNamespace.md.md)
* assembly [Zoro.Processor](../Zoro.Processor.md)

<!-- DO NOT EDIT: generated by xmldocmd for Zoro.Processor.dll -->
19 changes: 19 additions & 0 deletions docs/Dandraka.Zoro.Processor/DataMasking.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# DataMasking class

```csharp
public class DataMasking
```

## Public Members

| name | description |
| --- | --- |
| [DataMasking](DataMasking/DataMasking.md)(…) | |
| [Mask](DataMasking/Mask.md)() | |

## See Also

* namespace [Dandraka.Zoro.Processor](../Dandraka.Zoro.ProcessorNamespace.md.md)
* assembly [Zoro.Processor](../Zoro.Processor.md)

<!-- DO NOT EDIT: generated by xmldocmd for Zoro.Processor.dll -->
14 changes: 14 additions & 0 deletions docs/Dandraka.Zoro.Processor/DataMasking/DataMasking.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# DataMasking constructor

```csharp
public DataMasking(MaskConfig config)
```

## See Also

* class [MaskConfig](../MaskConfig.md)
* class [DataMasking](../DataMasking.md)
* namespace [Dandraka.Zoro.Processor](../DataMasking.md.md)
* assembly [Zoro.Processor](../../Zoro.Processor.md)

<!-- DO NOT EDIT: generated by xmldocmd for Zoro.Processor.dll -->
13 changes: 13 additions & 0 deletions docs/Dandraka.Zoro.Processor/DataMasking/Mask.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# DataMasking.Mask method

```csharp
public void Mask()
```

## See Also

* class [DataMasking](../DataMasking.md)
* namespace [Dandraka.Zoro.Processor](../DataMasking.md.md)
* assembly [Zoro.Processor](../../Zoro.Processor.md)

<!-- DO NOT EDIT: generated by xmldocmd for Zoro.Processor.dll -->
20 changes: 20 additions & 0 deletions docs/Dandraka.Zoro.Processor/DataSource.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# DataSource enumeration

```csharp
public enum DataSource
```

## Values

| name | value | description |
| --- | --- | --- |
| CsvFile | `0` | |
| Database | `1` | |
| JsonFile | `2` | |

## See Also

* namespace [Dandraka.Zoro.Processor](../Dandraka.Zoro.ProcessorNamespace.md.md)
* assembly [Zoro.Processor](../Zoro.Processor.md)

<!-- DO NOT EDIT: generated by xmldocmd for Zoro.Processor.dll -->
25 changes: 25 additions & 0 deletions docs/Dandraka.Zoro.Processor/FieldMask.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# FieldMask class

```csharp
public class FieldMask
```

## Public Members

| name | description |
| --- | --- |
| [FieldMask](FieldMask/FieldMask.md)() | The default constructor. |
| [Asterisk](FieldMask/Asterisk.md) { get; set; } | |
| [FieldName](FieldMask/FieldName.md) { getset; } | |
| [ListOfPossibleReplacements](FieldMask/ListOfPossibleReplacements.md) { getset; } | |
| [MaskType](FieldMask/MaskType.md) { getset; } | |
| [QueryReplacement](FieldMask/QueryReplacement.md) { getset; } | |
| [RegExGroupToReplace](FieldMask/RegExGroupToReplace.md) { getset; } | |
| [RegExMatch](FieldMask/RegExMatch.md) { getset; } | |

## See Also

* namespace [Dandraka.Zoro.Processor](../Dandraka.Zoro.ProcessorNamespace.md.md)
* assembly [Zoro.Processor](../Zoro.Processor.md)

<!-- DO NOT EDIT: generated by xmldocmd for Zoro.Processor.dll -->
13 changes: 13 additions & 0 deletions docs/Dandraka.Zoro.Processor/FieldMask/Asterisk.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# FieldMask.Asterisk property

```csharp
public string Asterisk { get; set; }
```

## See Also

* class [FieldMask](../FieldMask.md)
* namespace [Dandraka.Zoro.Processor](../FieldMask.md.md)
* assembly [Zoro.Processor](../../Zoro.Processor.md)

<!-- DO NOT EDIT: generated by xmldocmd for Zoro.Processor.dll -->
15 changes: 15 additions & 0 deletions docs/Dandraka.Zoro.Processor/FieldMask/FieldMask.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
# FieldMask constructor

The default constructor.

```csharp
public FieldMask()
```

## See Also

* class [FieldMask](../FieldMask.md)
* namespace [Dandraka.Zoro.Processor](../FieldMask.md.md)
* assembly [Zoro.Processor](../../Zoro.Processor.md)

<!-- DO NOT EDIT: generated by xmldocmd for Zoro.Processor.dll -->
13 changes: 13 additions & 0 deletions docs/Dandraka.Zoro.Processor/FieldMask/FieldName.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# FieldMask.FieldName property

```csharp
public string FieldName { get; set; }
```

## See Also

* class [FieldMask](../FieldMask.md)
* namespace [Dandraka.Zoro.Processor](../FieldMask.md.md)
* assembly [Zoro.Processor](../../Zoro.Processor.md)

<!-- DO NOT EDIT: generated by xmldocmd for Zoro.Processor.dll -->
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# FieldMask.ListOfPossibleReplacements property

```csharp
public List<Replacement> ListOfPossibleReplacements { get; set; }
```

## See Also

* class [Replacement](../Replacement.md)
* class [FieldMask](../FieldMask.md)
* namespace [Dandraka.Zoro.Processor](../FieldMask.md.md)
* assembly [Zoro.Processor](../../Zoro.Processor.md)

<!-- DO NOT EDIT: generated by xmldocmd for Zoro.Processor.dll -->
14 changes: 14 additions & 0 deletions docs/Dandraka.Zoro.Processor/FieldMask/MaskType.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# FieldMask.MaskType property

```csharp
public MaskType MaskType { get; set; }
```

## See Also

* enum [MaskType](../MaskType.md)
* class [FieldMask](../FieldMask.md)
* namespace [Dandraka.Zoro.Processor](../FieldMask.md.md)
* assembly [Zoro.Processor](../../Zoro.Processor.md)

<!-- DO NOT EDIT: generated by xmldocmd for Zoro.Processor.dll -->
14 changes: 14 additions & 0 deletions docs/Dandraka.Zoro.Processor/FieldMask/QueryReplacement.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# FieldMask.QueryReplacement property

```csharp
public QueryReplacement QueryReplacement { get; set; }
```

## See Also

* class [QueryReplacement](../QueryReplacement.md)
* class [FieldMask](../FieldMask.md)
* namespace [Dandraka.Zoro.Processor](../FieldMask.md.md)
* assembly [Zoro.Processor](../../Zoro.Processor.md)

<!-- DO NOT EDIT: generated by xmldocmd for Zoro.Processor.dll -->
13 changes: 13 additions & 0 deletions docs/Dandraka.Zoro.Processor/FieldMask/RegExGroupToReplace.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# FieldMask.RegExGroupToReplace property

```csharp
public int RegExGroupToReplace { get; set; }
```

## See Also

* class [FieldMask](../FieldMask.md)
* namespace [Dandraka.Zoro.Processor](../FieldMask.md.md)
* assembly [Zoro.Processor](../../Zoro.Processor.md)

<!-- DO NOT EDIT: generated by xmldocmd for Zoro.Processor.dll -->
13 changes: 13 additions & 0 deletions docs/Dandraka.Zoro.Processor/FieldMask/RegExMatch.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# FieldMask.RegExMatch property

```csharp
public string RegExMatch { get; set; }
```

## See Also

* class [FieldMask](../FieldMask.md)
* namespace [Dandraka.Zoro.Processor](../FieldMask.md.md)
* assembly [Zoro.Processor](../../Zoro.Processor.md)

<!-- DO NOT EDIT: generated by xmldocmd for Zoro.Processor.dll -->
32 changes: 32 additions & 0 deletions docs/Dandraka.Zoro.Processor/MaskConfig.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
# MaskConfig class

```csharp
public class MaskConfig
```

## Public Members

| name | description |
| --- | --- |
| [MaskConfig](MaskConfig/MaskConfig.md)() | The default constructor. |
| static [ReadConfig](MaskConfig/ReadConfig.md)(…) | |
| [InputFile](MaskConfig/InputFile.md) { get; set; } | |
| [OutputFile](MaskConfig/OutputFile.md) { getset; } | |
| [ConnectionString](MaskConfig/ConnectionString.md) | |
| [ConnectionType](MaskConfig/ConnectionType.md) | |
| [DataDestination](MaskConfig/DataDestination.md) | |
| [DataSource](MaskConfig/DataSource.md) | |
| [Delimiter](MaskConfig/Delimiter.md) | |
| [FieldMasks](MaskConfig/FieldMasks.md) | |
| [SqlCommand](MaskConfig/SqlCommand.md) | |
| [SqlSelect](MaskConfig/SqlSelect.md) | |
| [GetConnection](MaskConfig/GetConnection.md)() | |
| [SetConnection](MaskConfig/SetConnection.md)(…) | |
| static [SaveConfig](MaskConfig/SaveConfig.md)(…) | |

## See Also

* namespace [Dandraka.Zoro.Processor](../Dandraka.Zoro.ProcessorNamespace.md.md)
* assembly [Zoro.Processor](../Zoro.Processor.md)

<!-- DO NOT EDIT: generated by xmldocmd for Zoro.Processor.dll -->
13 changes: 13 additions & 0 deletions docs/Dandraka.Zoro.Processor/MaskConfig/ConnectionString.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# MaskConfig.ConnectionString field

```csharp
public string ConnectionString;
```

## See Also

* class [MaskConfig](../MaskConfig.md)
* namespace [Dandraka.Zoro.Processor](../MaskConfig.md.md)
* assembly [Zoro.Processor](../../Zoro.Processor.md)

<!-- DO NOT EDIT: generated by xmldocmd for Zoro.Processor.dll -->
13 changes: 13 additions & 0 deletions docs/Dandraka.Zoro.Processor/MaskConfig/ConnectionType.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# MaskConfig.ConnectionType field

```csharp
public string ConnectionType;
```

## See Also

* class [MaskConfig](../MaskConfig.md)
* namespace [Dandraka.Zoro.Processor](../MaskConfig.md.md)
* assembly [Zoro.Processor](../../Zoro.Processor.md)

<!-- DO NOT EDIT: generated by xmldocmd for Zoro.Processor.dll -->
14 changes: 14 additions & 0 deletions docs/Dandraka.Zoro.Processor/MaskConfig/DataDestination.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# MaskConfig.DataDestination field

```csharp
public DataDestination DataDestination;
```

## See Also

* enum [DataDestination](../DataDestination.md)
* class [MaskConfig](../MaskConfig.md)
* namespace [Dandraka.Zoro.Processor](../MaskConfig.md.md)
* assembly [Zoro.Processor](../../Zoro.Processor.md)

<!-- DO NOT EDIT: generated by xmldocmd for Zoro.Processor.dll -->
Loading

0 comments on commit 414e943

Please sign in to comment.