Browse Source

Documentation

Aryx 1 year ago
parent
commit
2cf2b810d4
3 changed files with 109 additions and 111 deletions
  1. 0 1
      AryxDevLibrary.csproj
  2. 0 1
      AryxDevLibrary4.0/AryxDevLibrary4.csproj
  3. 109 109
      README.md

+ 0 - 1
AryxDevLibrary.csproj

@@ -102,7 +102,6 @@
       <Generator>TextTemplatingFileGenerator</Generator>
       <LastGenOutput>AssemblyTTempl.cs</LastGenOutput>
     </Content>
-    <Content Include="gitOrange.ico" />
   </ItemGroup>
   <ItemGroup>
     <Service Include="{508349B6-6B84-4DF5-91F0-309BEEBAD82D}" />

+ 0 - 1
AryxDevLibrary4.0/AryxDevLibrary4.csproj

@@ -39,7 +39,6 @@
     <Reference Include="System.Xml" />
   </ItemGroup>
   <ItemGroup>
-    <Compile Include="Class1.cs" />
     <Compile Include="Properties\AssemblyInfo.cs" />
     <Compile Include="utils\logger\QueuedLogger.cs" />
   </ItemGroup>

+ 109 - 109
README.md

@@ -2,46 +2,46 @@
 Cette librairie contient un ensemble de classes utiles pour le développement de programmes C#.
 Documentation en anglais.
 
-##extensions.DateUtilsExt
+## extensions.DateUtilsExt
             
 Extensions methods for DateUtils object.
         
-###Methods
+### Methods
 
 
-####IsAfter(System.DateTime,System.DateTime)
+#### IsAfter(System.DateTime,System.DateTime)
 Test if a DateTime object is After an other.
-> #####Parameters
+> ##### Parameters
 > **date:** the date to test is after
 
 > **anotherDate:** anotherDate
 
-> #####Return value
+> ##### Return value
 > true if date is after anotehrDate. False if not, or equals
 
-####IsBefore(System.DateTime,System.DateTime)
+#### IsBefore(System.DateTime,System.DateTime)
 Test if a DateTime object is before an other.
-> #####Parameters
+> ##### Parameters
 > **date:** the date to test is before
 
 > **anotherDate:** anotherDate
 
-> #####Return value
+> ##### Return value
 > true if date is before anothe rDate. False if not, or equals
 
-####ChangeDate(System.DateTime,System.DateTime)
+#### ChangeDate(System.DateTime,System.DateTime)
 Return a new instance of DateTime, with date part (year, month, day) taken form another DateTime. Time preserved from original.
-> #####Parameters
+> ##### Parameters
 > **dateTime:** the input DateTime
 
 > **newDate:** the new DateTime to take date part
 
-> #####Return value
+> ##### Return value
 > A new instance of DateTime, with date part (year, month, day)
 
-####ChangeTime(System.DateTime,System.Int32,System.Int32,System.Int32,System.Int32)
+#### ChangeTime(System.DateTime,System.Int32,System.Int32,System.Int32,System.Int32)
 Change time part of a DateTime object.
-> #####Parameters
+> ##### Parameters
 > **dateTime:** input DateTime object
 
 > **hours:** new hour to set
@@ -52,314 +52,314 @@ Change time part of a DateTime object.
 
 > **milliseconds:** new millisecond to set
 
-> #####Return value
+> ##### Return value
 > A new DateTime object, with time part changed
 
-####ChangeTime(System.DateTime,System.TimeSpan)
+#### ChangeTime(System.DateTime,System.TimeSpan)
 Change time part of a DateTime object.
-> #####Parameters
+> ##### Parameters
 > **dateTime:** input DateTime object
 
 > **ts:** the TimeSpan object to take time part
 
-> #####Return value
+> ##### Return value
 > A new DateTime object, with time part changed
 
-##extensions.StringUtilsExt
+## extensions.StringUtilsExt
             
 Extension methods for the String class. Generaly refers to StringUtils.
         
-###Methods
+### Methods
 
 
-####SplitByStr(System.String,System.String)
+#### SplitByStr(System.String,System.String)
 Split a string by another string
-> #####Parameters
+> ##### Parameters
 > **strToSplit:** the string to split
 
 > **splitStr:** the string use to split
 
-> #####Return value
+> ##### Return value
 > an array of strings splitted
 
-####FirstUpperOtherLower(System.String)
+#### FirstUpperOtherLower(System.String)
 Capitalize the first letter and lower the others.
-> #####Parameters
+> ##### Parameters
 > **str:** this string
 
-> #####Return value
+> ##### Return value
 > The string with the first letter upped and lowered the others
 
-####IsEmpty(System.String)
+#### IsEmpty(System.String)
 Test if the string is empty.
-> #####Parameters
+> ##### Parameters
 > **value:** this string
 
-> #####Return value
+> ##### Return value
 > true if empty (lenght = 0 or ""), false or not.
 
-####Tronc(System.String,System.Int32)
+#### Tronc(System.String,System.Int32)
 Truncate the string.
-> #####Parameters
+> ##### Parameters
 > **str:** the string to truncate
 
 > **limit:** le lenght to truncate
 
-> #####Return value
+> ##### Return value
 > 
 
-####Truncate(System.String,System.Int32)
+#### Truncate(System.String,System.Int32)
 Truncate the string.
-> #####Parameters
+> ##### Parameters
 > **str:** the string to truncate
 
 > **limit:** le lenght to truncate
 
-> #####Return value
+> ##### Return value
 > Returns the truncated string, or the complete string if the limit is greater than or equal to the length of the input string.
 
-####ReplaceFirst(System.String,System.String,System.String)
+#### ReplaceFirst(System.String,System.String,System.String)
 Replace the first occurence of a substring in a string.
-> #####Parameters
+> ##### Parameters
 > **str:** The string in which to search
 
 > **search:** The substring to search for
 
 > **replace:** The replacement
 
-> #####Return value
+> ##### Return value
 > The string with replacement done if exists.
 
-####RemoveDiacritics(System.String)
+#### RemoveDiacritics(System.String)
 Remove diacritics acent in a string. Source : https://stackoverflow.com/questions/249087/how-do-i-remove-diacritics-accents-from-a-string-in-net
-> #####Parameters
+> ##### Parameters
 > **text:** the string
 
-> #####Return value
+> ##### Return value
 > the string without diacritics accents
 
-####Matches(System.String,System.String)
+#### Matches(System.String,System.String)
 Tells whether or not this string matches the given regular expression.
-> #####Parameters
+> ##### Parameters
 > **text:** the input string to test
 
 > **regex:** the regular expression to which this string is to be matched
 
-> #####Return value
+> ##### Return value
 > true if, and only if, this string matches the given regular expression
 
-##utils.ConsoleUtils.Reader
+## utils.ConsoleUtils.Reader
             
 Fournit des méthodes pour avoir un Console.Readline avec timeout https://stackoverflow.com/a/18342182
         
-###Methods
+### Methods
 
 
-####ReadLine(System.Int32)
+#### ReadLine(System.Int32)
 Affiche un readline avec timeout. Renvoie une exception, si le timeout est dépassé.
-> #####Parameters
+> ##### Parameters
 > **timeOutMillisecs:** 
 
-> #####Return value
+> ##### Return value
 > 
 
-####TryReadLine(System.String@,System.Int32)
+#### TryReadLine(System.String@,System.Int32)
 Affiche un readline avec timeout. Renvoie false si le délai est dépassé; true et le texte dans la variable en out sinon.
-> #####Parameters
+> ##### Parameters
 > **line:** 
 
 > **timeOutMillisecs:** 
 
-> #####Return value
+> ##### Return value
 > 
 
-##utils.ShortcutUtils
+## utils.ShortcutUtils
             
 Note : when using this class, and using IWshShortcut interface in your project, you will have to use this reference "Interop.IWshRuntimeLibrary". To avoid compilation issues, make sure to set "False" for the property "Embed Interop Types" of the "Interop.IWshRuntimeLibrary" Reference in your project.
         
 
-##utils.StringUtils
+## utils.StringUtils
             
 Static method for Strings.
         
-###Fields
+### Fields
 
-####AUTH_FILENAME_CHARS
+#### AUTH_FILENAME_CHARS
 Characters allowed in a Windows filename.
-###Methods
+### Methods
 
 
-####SubstringsByLen(System.String,System.Int32)
+#### SubstringsByLen(System.String,System.Int32)
 Cuts a string, and n parts of delimited lengths.
-> #####Parameters
+> ##### Parameters
 > **str:** input string
 
 > **len:** lenght of string to cut
 
-> #####Return value
+> ##### Return value
 > Array of strings
 
-####Split(System.String,System.String)
+#### Split(System.String,System.String)
 Split a string by another string
-> #####Parameters
+> ##### Parameters
 > **strToSplit:** the string to split
 
 > **splitStr:** the string use to split
 
-> #####Return value
+> ##### Return value
 > an array of strings splitted
 
-####FirstUpperOtherLower(System.String)
+#### FirstUpperOtherLower(System.String)
 Capitalize the first letter and lower the others.
-> #####Parameters
+> ##### Parameters
 > **str:** this string
 
-> #####Return value
+> ##### Return value
 > The string with the first letter upped and lowered the others
 
-####Tronc(System.String,System.Int32)
+#### Tronc(System.String,System.Int32)
 Truncate the string.
-> #####Parameters
+> ##### Parameters
 > **str:** the string to truncate
 
 > **limit:** le lenght to truncate
 
-> #####Return value
+> ##### Return value
 > The string with truncate
 
-####TroncRight(System.String,System.Int32,System.String)
+#### TroncRight(System.String,System.Int32,System.String)
 Trunc a string from the right if string's lenght greater than defined lenght. A suffix can be use for indicate trunc.
-> #####Parameters
+> ##### Parameters
 > **str:** The string to truncate
 
 > **maxLenght:** The length from which to truncate
 
 > **suffix:** The suffix to indicate truncate. Default=""
 
-> #####Return value
+> ##### Return value
 > The string with truncate
 
-####IsEmpty(System.String)
+#### IsEmpty(System.String)
 Test if a string is empty.
-> #####Parameters
+> ##### Parameters
 > **str:** the string to test
 
-> #####Return value
+> ##### Return value
 > true if null, is empty (length = 0 or equals "")
 
-####Truncate(System.String,System.Int32)
+#### Truncate(System.String,System.Int32)
 Truncate the string with limit lenght
-> #####Parameters
+> ##### Parameters
 > **str:** the string to truncate
 
 > **limit:** le lenght to truncate
 
-> #####Return value
+> ##### Return value
 > Returns the truncated string, or the complete string if the limit is greater than or equal to the length of the input string.
 
-####TruncRight(System.String,System.Int32,System.String)
+#### TruncRight(System.String,System.Int32,System.String)
 Trunc a string from the right if string's lenght greater than defined lenght. A suffix can be use for indicate trunc.
-> #####Parameters
+> ##### Parameters
 > **str:** The string to truncate
 
 > **maxLenght:** The length from which to truncate
 
 > **suffix:** The suffix to indicate truncate. Default=""
 
-> #####Return value
+> ##### Return value
 > The string with truncate
 
-####ReplaceFirst(System.String,System.String,System.String)
+#### ReplaceFirst(System.String,System.String,System.String)
 Replace the first occurence of a substring in a string.
-> #####Parameters
+> ##### Parameters
 > **str:** The string in which to search
 
 > **search:** The substring to search for
 
 > **replace:** The replacement
 
-> #####Return value
+> ##### Return value
 > The string with replacement done if exists.
 
-####RemoveDiacritics(System.String)
+#### RemoveDiacritics(System.String)
 Remove diacritics acent in a string. Source : https://stackoverflow.com/questions/249087/how-do-i-remove-diacritics-accents-from-a-string-in-net
-> #####Parameters
+> ##### Parameters
 > **text:** the string
 
-> #####Return value
+> ##### Return value
 > the string without diacritics accents
 
-####RemoveCharDifferentThan(System.String,System.String)
+#### RemoveCharDifferentThan(System.String,System.String)
 Removes characters in a string from a set of characters (placed in a string).
-> #####Parameters
+> ##### Parameters
 > **str:** The string in which to work
 
 > **charList:** the set of characters
 
-> #####Return value
+> ##### Return value
 > 
 
-####IsNullOrWhiteSpace(System.String)
+#### IsNullOrWhiteSpace(System.String)
 Check if a string is null, or contains only whitespaces. Same role that IsNullOrWhiteSpace(...) in .Net Framework 4
-> #####Parameters
+> ##### Parameters
 > **str:** The string to test
 
-> #####Return value
+> ##### Return value
 > true if string is null, empty or contains only whitespace.
 
-####TextOrDefault(System.String,System.String,System.Boolean)
+#### TextOrDefault(System.String,System.String,System.Boolean)
 Returns a string if not null, or a default text if not.
-> #####Parameters
+> ##### Parameters
 > **text:** the text
 
 > **defaut:** default string
 
 > **isTestEmpty:** 
 
-> #####Return value
+> ##### Return value
 > 
 
-####Matches(System.String,System.String)
+#### Matches(System.String,System.String)
 Tells whether or not this string matches the given regular expression.
-> #####Parameters
+> ##### Parameters
 > **text:** the input string to test
 
 > **regex:** the regular expression to which this string is to be matched
 
-> #####Return value
+> ##### Return value
 > true if, and only if, this string matches the given regular expression
 
-####CsvStringContains(System.String,System.String,System.Char)
+#### CsvStringContains(System.String,System.String,System.Char)
 Tests if a string is contained in an array of elements, separated by a semicolon like a CSV line.
-> #####Parameters
+> ##### Parameters
 > **toSearch:** String to search
 
 > **csvSepString:** String where to search
 
 > **sepChar:** The separator. Semicolon by default
 
-> #####Return value
+> ##### Return value
 > 
 
-####RandomString(System.Int32,System.String,System.Boolean)
+#### RandomString(System.Int32,System.String,System.Boolean)
 Return a string with random char and with a defined lenght. Charset is customizable.
-> #####Parameters
+> ##### Parameters
 > **length:** Lenght of the string
 
 > **charSet:** The charset
 
 > **ensureUnique:** If true, ensures that the generated string has not already been generated previously. Use the ClearRandomStringCache() method to clean the string cache already generated.
 
-> #####Return value
+> ##### Return value
 > 
 
-####ClearRandomStringCache
+#### ClearRandomStringCache
 Cleans the cache of strings generated with the RandomString() method.
 
-####NumberToText(System.Int32)
+#### NumberToText(System.Int32)
 Converts an integer into its textual form. The output is only in France-French.
-> #####Parameters
+> ##### Parameters
 > **n:** the integer to convert to
 
-> #####Return value
-> The textual form of integer. France-French only
+> ##### Return value
+> The textual form of integer. France-French only