Updated documentation to reflect latest changes fa8fa8d

Aptivi · Sep 18, 2023 · 6ed1c86 · 6ed1c86
1 parent e409b1a
commit 6ed1c86
Show file tree

Hide file tree

Showing 27 changed files with 370 additions and 324 deletions.
diff --git a/api/VisualCard.CardTools.html b/api/VisualCard.CardTools.html
@@ -228,7 +228,8 @@ <h5 class="parameters">Parameters</h5>
       <tr>
         <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
         <td><span class="parametername">cardText</span></td>
-        <td></td>
+        <td><p>Contacts text</p>
+</td>
       </tr>
     </tbody>
   </table>

diff --git a/api/VisualCard.Exceptions.VCardParseException.html b/api/VisualCard.Exceptions.VCardParseException.html
@@ -83,7 +83,8 @@
 
   <h1 id="VisualCard_Exceptions_VCardParseException" data-uid="VisualCard.Exceptions.VCardParseException" class="text-break">Class VCardParseException
 </h1>
-  <div class="markdown level0 summary"></div>
+  <div class="markdown level0 summary"><p>Exception of VCard parsing</p>
+</div>
   <div class="markdown level0 conceptual"></div>
   <div class="inheritance">
     <h5>Inheritance</h5>
@@ -104,7 +105,7 @@ <h3 id="constructors">Constructors
     <a href="https://github.com/Aptivi/VisualCard/new/main/apiSpec/new?filename=VisualCard_Exceptions_VCardParseException__ctor.md&amp;value=---%0Auid%3A%20VisualCard.Exceptions.VCardParseException.%23ctor%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
   </span>
   <span class="small pull-right mobile-hide">
-    <a href="https://github.com/Aptivi/VisualCard/blob/main/VisualCard/Exceptions/VCardParseException.cs/#L32">View Source</a>
+    <a href="https://github.com/Aptivi/VisualCard/blob/main/VisualCard/Exceptions/VCardParseException.cs/#L36">View Source</a>
   </span>
   <a id="VisualCard_Exceptions_VCardParseException__ctor_" data-uid="VisualCard.Exceptions.VCardParseException.#ctor*"></a>
   <h4 id="VisualCard_Exceptions_VCardParseException__ctor" data-uid="VisualCard.Exceptions.VCardParseException.#ctor">VCardParseException()</h4>
@@ -119,11 +120,12 @@ <h5 class="declaration">Declaration</h5>
     <a href="https://github.com/Aptivi/VisualCard/new/main/apiSpec/new?filename=VisualCard_Exceptions_VCardParseException__ctor_System_String_System_String_System_Int32_System_Exception_.md&amp;value=---%0Auid%3A%20VisualCard.Exceptions.VCardParseException.%23ctor(System.String%2CSystem.String%2CSystem.Int32%2CSystem.Exception)%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
   </span>
   <span class="small pull-right mobile-hide">
-    <a href="https://github.com/Aptivi/VisualCard/blob/main/VisualCard/Exceptions/VCardParseException.cs/#L37">View Source</a>
+    <a href="https://github.com/Aptivi/VisualCard/blob/main/VisualCard/Exceptions/VCardParseException.cs/#L48">View Source</a>
   </span>
   <a id="VisualCard_Exceptions_VCardParseException__ctor_" data-uid="VisualCard.Exceptions.VCardParseException.#ctor*"></a>
   <h4 id="VisualCard_Exceptions_VCardParseException__ctor_System_String_System_String_System_Int32_System_Exception_" data-uid="VisualCard.Exceptions.VCardParseException.#ctor(System.String,System.String,System.Int32,System.Exception)">VCardParseException(string, string, int, Exception)</h4>
-  <div class="markdown level1 summary"></div>
+  <div class="markdown level1 summary"><p>Indicates that there was something wrong with parsing</p>
+</div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="declaration">Declaration</h5>
   <div class="codewrapper">
@@ -142,22 +144,26 @@ <h5 class="parameters">Parameters</h5>
       <tr>
         <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
         <td><span class="parametername">message</span></td>
-        <td></td>
+        <td><p>The message to clarify the reasoning for the error</p>
+</td>
       </tr>
       <tr>
         <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.string">string</a></td>
         <td><span class="parametername">line</span></td>
-        <td></td>
+        <td><p>Line in which it caused the error</p>
+</td>
       </tr>
       <tr>
         <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.int32">int</a></td>
         <td><span class="parametername">linenumber</span></td>
-        <td></td>
+        <td><p>Line number in which it caused the error</p>
+</td>
       </tr>
       <tr>
         <td><a class="xref" href="https://learn.microsoft.com/dotnet/api/system.exception">Exception</a></td>
         <td><span class="parametername">innerException</span></td>
-        <td></td>
+        <td><p>Inner exception (if any)</p>
+</td>
       </tr>
     </tbody>
   </table>
@@ -173,7 +179,7 @@ <h5 class="parameters">Parameters</h5>
                     <a href="https://github.com/Aptivi/VisualCard/new/main/apiSpec/new?filename=VisualCard_Exceptions_VCardParseException.md&amp;value=---%0Auid%3A%20VisualCard.Exceptions.VCardParseException%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Edit this page</a>
                   </li>
                   <li>
-                    <a href="https://github.com/Aptivi/VisualCard/blob/main/VisualCard/Exceptions/VCardParseException.cs/#L30" class="contribution-link">View Source</a>
+                    <a href="https://github.com/Aptivi/VisualCard/blob/main/VisualCard/Exceptions/VCardParseException.cs/#L33" class="contribution-link">View Source</a>
                   </li>
                 </ul>
               </div>

diff --git a/api/VisualCard.Exceptions.html b/api/VisualCard.Exceptions.html
@@ -88,7 +88,8 @@ <h3 id="classes">
 Classes
 </h3>
       <h4><a class="xref" href="VisualCard.Exceptions.VCardParseException.html">VCardParseException</a></h4>
-      <section></section>
+      <section><p>Exception of VCard parsing</p>
+</section>
 
 
 </article>

diff --git a/api/VisualCard.Parsers.BaseVcardParser.html b/api/VisualCard.Parsers.BaseVcardParser.html
@@ -83,7 +83,8 @@
 
   <h1 id="VisualCard_Parsers_BaseVcardParser" data-uid="VisualCard.Parsers.BaseVcardParser" class="text-break">Class BaseVcardParser
 </h1>
-  <div class="markdown level0 summary"></div>
+  <div class="markdown level0 summary"><p>The base VCard parser</p>
+</div>
   <div class="markdown level0 conceptual"></div>
   <div class="inheritance">
     <h5>Inheritance</h5>
@@ -110,11 +111,11 @@ <h3 id="properties">Properties
     <a href="https://github.com/Aptivi/VisualCard/new/main/apiSpec/new?filename=VisualCard_Parsers_BaseVcardParser_CardContent.md&amp;value=---%0Auid%3A%20VisualCard.Parsers.BaseVcardParser.CardContent%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
   </span>
   <span class="small pull-right mobile-hide">
-    <a href="https://github.com/Aptivi/VisualCard/blob/main/VisualCard/Parsers/BaseVcardParser.cs/#L33">View Source</a>
+    <a href="https://github.com/Aptivi/VisualCard/blob/main/VisualCard/Parsers/BaseVcardParser.cs/#L39">View Source</a>
   </span>
   <a id="VisualCard_Parsers_BaseVcardParser_CardContent_" data-uid="VisualCard.Parsers.BaseVcardParser.CardContent*"></a>
   <h4 id="VisualCard_Parsers_BaseVcardParser_CardContent" data-uid="VisualCard.Parsers.BaseVcardParser.CardContent">CardContent</h4>
-  <div class="markdown level1 summary"><p>Contents of the VCard</p>
+  <div class="markdown level1 summary"><p>VCard card content</p>
 </div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="declaration">Declaration</h5>
@@ -141,11 +142,11 @@ <h5 class="propertyValue">Property Value</h5>
     <a href="https://github.com/Aptivi/VisualCard/new/main/apiSpec/new?filename=VisualCard_Parsers_BaseVcardParser_CardVersion.md&amp;value=---%0Auid%3A%20VisualCard.Parsers.BaseVcardParser.CardVersion%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
   </span>
   <span class="small pull-right mobile-hide">
-    <a href="https://github.com/Aptivi/VisualCard/blob/main/VisualCard/Parsers/BaseVcardParser.cs/#L34">View Source</a>
+    <a href="https://github.com/Aptivi/VisualCard/blob/main/VisualCard/Parsers/BaseVcardParser.cs/#L43">View Source</a>
   </span>
   <a id="VisualCard_Parsers_BaseVcardParser_CardVersion_" data-uid="VisualCard.Parsers.BaseVcardParser.CardVersion*"></a>
   <h4 id="VisualCard_Parsers_BaseVcardParser_CardVersion" data-uid="VisualCard.Parsers.BaseVcardParser.CardVersion">CardVersion</h4>
-  <div class="markdown level1 summary"><p>The version of the card</p>
+  <div class="markdown level1 summary"><p>VCard card version</p>
 </div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="declaration">Declaration</h5>
@@ -174,11 +175,11 @@ <h3 id="methods">Methods
     <a href="https://github.com/Aptivi/VisualCard/new/main/apiSpec/new?filename=VisualCard_Parsers_BaseVcardParser_Parse.md&amp;value=---%0Auid%3A%20VisualCard.Parsers.BaseVcardParser.Parse%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
   </span>
   <span class="small pull-right mobile-hide">
-    <a href="https://github.com/Aptivi/VisualCard/blob/main/VisualCard/Parsers/BaseVcardParser.cs/#L36">View Source</a>
+    <a href="https://github.com/Aptivi/VisualCard/blob/main/VisualCard/Parsers/BaseVcardParser.cs/#L49">View Source</a>
   </span>
   <a id="VisualCard_Parsers_BaseVcardParser_Parse_" data-uid="VisualCard.Parsers.BaseVcardParser.Parse*"></a>
   <h4 id="VisualCard_Parsers_BaseVcardParser_Parse" data-uid="VisualCard.Parsers.BaseVcardParser.Parse">Parse()</h4>
-  <div class="markdown level1 summary"><p>Parses the VCard file</p>
+  <div class="markdown level1 summary"><p>Parses a VCard contact</p>
 </div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="declaration">Declaration</h5>
@@ -196,7 +197,8 @@ <h5 class="returns">Returns</h5>
     <tbody>
       <tr>
         <td><a class="xref" href="VisualCard.Parts.Card.html">Card</a></td>
-        <td></td>
+        <td><p>A strongly-typed <a class="xref" href="VisualCard.Parts.Card.html">Card</a> instance holding information about the card</p>
+</td>
       </tr>
     </tbody>
   </table>
@@ -216,7 +218,7 @@ <h3 id="implements">Implements</h3>
                     <a href="https://github.com/Aptivi/VisualCard/new/main/apiSpec/new?filename=VisualCard_Parsers_BaseVcardParser.md&amp;value=---%0Auid%3A%20VisualCard.Parsers.BaseVcardParser%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Edit this page</a>
                   </li>
                   <li>
-                    <a href="https://github.com/Aptivi/VisualCard/blob/main/VisualCard/Parsers/BaseVcardParser.cs/#L31" class="contribution-link">View Source</a>
+                    <a href="https://github.com/Aptivi/VisualCard/blob/main/VisualCard/Parsers/BaseVcardParser.cs/#L34" class="contribution-link">View Source</a>
                   </li>
                 </ul>
               </div>

diff --git a/api/VisualCard.Parsers.Four.VcardFour.html b/api/VisualCard.Parsers.Four.VcardFour.html
@@ -109,11 +109,11 @@ <h3 id="properties">Properties
     <a href="https://github.com/Aptivi/VisualCard/new/main/apiSpec/new?filename=VisualCard_Parsers_Four_VcardFour_CardContent.md&amp;value=---%0Auid%3A%20VisualCard.Parsers.Four.VcardFour.CardContent%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
   </span>
   <span class="small pull-right mobile-hide">
-    <a href="https://github.com/Aptivi/VisualCard/blob/main/VisualCard/Parsers/Four/VcardFour.cs/#L44">View Source</a>
+    <a href="https://github.com/Aptivi/VisualCard/blob/main/VisualCard/Parsers/Four/VcardFour.cs/#L45">View Source</a>
   </span>
   <a id="VisualCard_Parsers_Four_VcardFour_CardContent_" data-uid="VisualCard.Parsers.Four.VcardFour.CardContent*"></a>
   <h4 id="VisualCard_Parsers_Four_VcardFour_CardContent" data-uid="VisualCard.Parsers.Four.VcardFour.CardContent">CardContent</h4>
-  <div class="markdown level1 summary"><p>Contents of the VCard</p>
+  <div class="markdown level1 summary"><p>VCard card content</p>
 </div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="declaration">Declaration</h5>
@@ -142,11 +142,11 @@ <h5 class="overrides">Overrides</h5>
     <a href="https://github.com/Aptivi/VisualCard/new/main/apiSpec/new?filename=VisualCard_Parsers_Four_VcardFour_CardVersion.md&amp;value=---%0Auid%3A%20VisualCard.Parsers.Four.VcardFour.CardVersion%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
   </span>
   <span class="small pull-right mobile-hide">
-    <a href="https://github.com/Aptivi/VisualCard/blob/main/VisualCard/Parsers/Four/VcardFour.cs/#L45">View Source</a>
+    <a href="https://github.com/Aptivi/VisualCard/blob/main/VisualCard/Parsers/Four/VcardFour.cs/#L47">View Source</a>
   </span>
   <a id="VisualCard_Parsers_Four_VcardFour_CardVersion_" data-uid="VisualCard.Parsers.Four.VcardFour.CardVersion*"></a>
   <h4 id="VisualCard_Parsers_Four_VcardFour_CardVersion" data-uid="VisualCard.Parsers.Four.VcardFour.CardVersion">CardVersion</h4>
-  <div class="markdown level1 summary"><p>The version of the card</p>
+  <div class="markdown level1 summary"><p>VCard card version</p>
 </div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="declaration">Declaration</h5>
@@ -177,11 +177,11 @@ <h3 id="methods">Methods
     <a href="https://github.com/Aptivi/VisualCard/new/main/apiSpec/new?filename=VisualCard_Parsers_Four_VcardFour_Parse.md&amp;value=---%0Auid%3A%20VisualCard.Parsers.Four.VcardFour.Parse%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
   </span>
   <span class="small pull-right mobile-hide">
-    <a href="https://github.com/Aptivi/VisualCard/blob/main/VisualCard/Parsers/Four/VcardFour.cs/#L47">View Source</a>
+    <a href="https://github.com/Aptivi/VisualCard/blob/main/VisualCard/Parsers/Four/VcardFour.cs/#L50">View Source</a>
   </span>
   <a id="VisualCard_Parsers_Four_VcardFour_Parse_" data-uid="VisualCard.Parsers.Four.VcardFour.Parse*"></a>
   <h4 id="VisualCard_Parsers_Four_VcardFour_Parse" data-uid="VisualCard.Parsers.Four.VcardFour.Parse">Parse()</h4>
-  <div class="markdown level1 summary"><p>Parses the VCard file</p>
+  <div class="markdown level1 summary"><p>Parses a VCard contact</p>
 </div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="declaration">Declaration</h5>
@@ -199,7 +199,8 @@ <h5 class="returns">Returns</h5>
     <tbody>
       <tr>
         <td><a class="xref" href="VisualCard.Parts.Card.html">Card</a></td>
-        <td></td>
+        <td><p>A strongly-typed <a class="xref" href="VisualCard.Parts.Card.html">Card</a> instance holding information about the card</p>
+</td>
       </tr>
     </tbody>
   </table>

diff --git a/api/VisualCard.Parsers.Three.VcardThree.html b/api/VisualCard.Parsers.Three.VcardThree.html
@@ -109,11 +109,11 @@ <h3 id="properties">Properties
     <a href="https://github.com/Aptivi/VisualCard/new/main/apiSpec/new?filename=VisualCard_Parsers_Three_VcardThree_CardContent.md&amp;value=---%0Auid%3A%20VisualCard.Parsers.Three.VcardThree.CardContent%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
   </span>
   <span class="small pull-right mobile-hide">
-    <a href="https://github.com/Aptivi/VisualCard/blob/main/VisualCard/Parsers/Three/VcardThree.cs/#L44">View Source</a>
+    <a href="https://github.com/Aptivi/VisualCard/blob/main/VisualCard/Parsers/Three/VcardThree.cs/#L45">View Source</a>
   </span>
   <a id="VisualCard_Parsers_Three_VcardThree_CardContent_" data-uid="VisualCard.Parsers.Three.VcardThree.CardContent*"></a>
   <h4 id="VisualCard_Parsers_Three_VcardThree_CardContent" data-uid="VisualCard.Parsers.Three.VcardThree.CardContent">CardContent</h4>
-  <div class="markdown level1 summary"><p>Contents of the VCard</p>
+  <div class="markdown level1 summary"><p>VCard card content</p>
 </div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="declaration">Declaration</h5>
@@ -142,11 +142,11 @@ <h5 class="overrides">Overrides</h5>
     <a href="https://github.com/Aptivi/VisualCard/new/main/apiSpec/new?filename=VisualCard_Parsers_Three_VcardThree_CardVersion.md&amp;value=---%0Auid%3A%20VisualCard.Parsers.Three.VcardThree.CardVersion%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
   </span>
   <span class="small pull-right mobile-hide">
-    <a href="https://github.com/Aptivi/VisualCard/blob/main/VisualCard/Parsers/Three/VcardThree.cs/#L45">View Source</a>
+    <a href="https://github.com/Aptivi/VisualCard/blob/main/VisualCard/Parsers/Three/VcardThree.cs/#L47">View Source</a>
   </span>
   <a id="VisualCard_Parsers_Three_VcardThree_CardVersion_" data-uid="VisualCard.Parsers.Three.VcardThree.CardVersion*"></a>
   <h4 id="VisualCard_Parsers_Three_VcardThree_CardVersion" data-uid="VisualCard.Parsers.Three.VcardThree.CardVersion">CardVersion</h4>
-  <div class="markdown level1 summary"><p>The version of the card</p>
+  <div class="markdown level1 summary"><p>VCard card version</p>
 </div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="declaration">Declaration</h5>
@@ -177,11 +177,11 @@ <h3 id="methods">Methods
     <a href="https://github.com/Aptivi/VisualCard/new/main/apiSpec/new?filename=VisualCard_Parsers_Three_VcardThree_Parse.md&amp;value=---%0Auid%3A%20VisualCard.Parsers.Three.VcardThree.Parse%0Asummary%3A%20&#39;*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax&#39;%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Edit this page</a>
   </span>
   <span class="small pull-right mobile-hide">
-    <a href="https://github.com/Aptivi/VisualCard/blob/main/VisualCard/Parsers/Three/VcardThree.cs/#L47">View Source</a>
+    <a href="https://github.com/Aptivi/VisualCard/blob/main/VisualCard/Parsers/Three/VcardThree.cs/#L50">View Source</a>
   </span>
   <a id="VisualCard_Parsers_Three_VcardThree_Parse_" data-uid="VisualCard.Parsers.Three.VcardThree.Parse*"></a>
   <h4 id="VisualCard_Parsers_Three_VcardThree_Parse" data-uid="VisualCard.Parsers.Three.VcardThree.Parse">Parse()</h4>
-  <div class="markdown level1 summary"><p>Parses the VCard file</p>
+  <div class="markdown level1 summary"><p>Parses a VCard contact</p>
 </div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="declaration">Declaration</h5>
@@ -199,7 +199,8 @@ <h5 class="returns">Returns</h5>
     <tbody>
       <tr>
         <td><a class="xref" href="VisualCard.Parts.Card.html">Card</a></td>
-        <td></td>
+        <td><p>A strongly-typed <a class="xref" href="VisualCard.Parts.Card.html">Card</a> instance holding information about the card</p>
+</td>
       </tr>
     </tbody>
   </table>