Skip to content

Commit

Permalink
Project reference
Browse files Browse the repository at this point in the history
  • Loading branch information
FolkerKinzel committed Feb 12, 2021
1 parent 239922f commit be03566
Show file tree
Hide file tree
Showing 10 changed files with 20 additions and 16 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,10 @@
<ProjectSummary>Die Namensr&amp;#228%3bume FolkerKinzel.Contacts und FolkerKinzel.Contacts.IO stellen eine einfache .NET-API zum Speichern und Bearbeiten von Kontaktdaten von Organisationen und nat&amp;#252%3brlichen Personen dar.</ProjectSummary>
<NamespaceSummaries>
<NamespaceSummaryItem name="FolkerKinzel.Contacts (Group)" isGroup="True" isDocumented="True">Die Namensräume FolkerKinzel.Contacts und FolkerKinzel.Contacts.IO stellen eine einfache .NET-Api zum Speichern und Bearbeiten von Kontaktdaten von Organisationen und natürlichen Personen dar. Im Namensraum FolkerKinzel.Contacts befindet sich das Datenmodell und der Namensraum FolkerKinzel.Contacts.IO stellt Klassen zur Verfügung, um dieses als CSV oder vCard (*.vcf) zu persistieren.</NamespaceSummaryItem>
<NamespaceSummaryItem name="FolkerKinzel.Contacts" isDocumented="True">Der Namensraum enthält ein einfaches Datenmodell zum Speichern von Kontaktdaten von Organisationen und natürlichen Personen.</NamespaceSummaryItem>
<NamespaceSummaryItem name="FolkerKinzel.Contacts.IO" isDocumented="True">Der Namensraum stellt Klassen zur Verfügung, die dazu dienen, die in der Klasse FolkerKinzel.Contacts.Contact gespeicherten Kontaktdaten als CSV oder vCard (*.vcf) zu persistieren.</NamespaceSummaryItem></NamespaceSummaries>
<NamespaceSummaryItem name="FolkerKinzel.Contacts" isDocumented="True">Der Namensraum enthält ein einfaches Datenmodell zum Speichern von Kontaktdaten von Organisationen und natürlichen Personen.</NamespaceSummaryItem>
<NamespaceSummaryItem name="FolkerKinzel.Contacts.IO" isDocumented="True">Der Namensraum stellt Klassen zur Verfügung, die dazu dienen, die in der Klasse FolkerKinzel.Contacts.Contact gespeicherten Kontaktdaten als CSV oder vCard (*.vcf) zu persistieren.</NamespaceSummaryItem>
</NamespaceSummaries>
<VisibleItems>ExplicitInterfaceImplementations, InheritedMembers, InheritedFrameworkMembers, Protected, ProtectedInternalAsProtected, NonBrowsable</VisibleItems>
</PropertyGroup>
<!-- There are no properties for these groups. AnyCPU needs to appear in order for Visual Studio to perform
the build. The others are optional common platform types that may appear. -->
Expand Down
Binary file not shown.
Original file line number Diff line number Diff line change
Expand Up @@ -54,8 +54,10 @@
<ProjectSummary>Easy to use .NET-API to manage contact data of organizations or natural persons.</ProjectSummary>
<NamespaceSummaries>
<NamespaceSummaryItem name="FolkerKinzel.Contacts (Group)" isGroup="True" isDocumented="True">The namespaces FolkerKinzel.Contacts and FolkerKinzel.Contacts.IO represent a simple .NET API for storing and editing contact data of organizations and natural persons. The namespace FolkerKinzel.Contacts contains the data model and the namespace FolkerKinzel.Contacts.IO provides classes to persist it as CSV or vCard (*.vcf).</NamespaceSummaryItem>
<NamespaceSummaryItem name="FolkerKinzel.Contacts" isDocumented="True">Data model to store contact data of organizations or natural persons.</NamespaceSummaryItem>
<NamespaceSummaryItem name="FolkerKinzel.Contacts.IO" isDocumented="True">Classes to save and load FolkerKinzel.Contacts.Contact objects as CSV or vCard (*.vcf).</NamespaceSummaryItem></NamespaceSummaries>
<NamespaceSummaryItem name="FolkerKinzel.Contacts" isDocumented="True">Data model to store contact data of organizations or natural persons.</NamespaceSummaryItem>
<NamespaceSummaryItem name="FolkerKinzel.Contacts.IO" isDocumented="True">Classes to save and load FolkerKinzel.Contacts.Contact objects as CSV or vCard (*.vcf).</NamespaceSummaryItem>
</NamespaceSummaries>
<VisibleItems>ExplicitInterfaceImplementations, InheritedMembers, InheritedFrameworkMembers, Protected, ProtectedInternalAsProtected, NonBrowsable</VisibleItems>
</PropertyGroup>
<!-- There are no properties for these groups. AnyCPU needs to appear in order for Visual Studio to perform
the build. The others are optional common platform types that may appear. -->
Expand Down
Binary file not shown.
2 changes: 1 addition & 1 deletion FolkerKinzel.Contacts.IO/FolkerKinzel.Contacts.IO.csproj
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
<PackageId>FolkerKinzel.Contacts.IO</PackageId>
<Product>FolkerKinzel.Contacts.IO</Product>
<Version>1.3.0-beta</Version>
<FileVersion>1.3.0.1</FileVersion>
<FileVersion>1.3.0.2</FileVersion>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<EnableNETAnalyzers>true</EnableNETAnalyzers>
<AnalysisMode>AllEnabledByDefault</AnalysisMode>
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@
<T ID="64F42C9B7773BFAF">The file could not be written.</T>
<T ID="DC4A57C97C58352A">&lt;para&gt; The method calls &lt;see cref ="M:FolkerKinzel.Contacts.Contact.Clean"/&gt; on &lt;paramref name ="contact"/&gt;. If the property &lt;see cref ="P:FolkerKinzel.Contacts.Contact.IsEmpty"/&gt; of &lt;paramref name ="contact"/&gt; then returns &lt;c&gt;true&lt;/c&gt;, no file is created. If it is undesirable for the method to change &lt;paramref name ="contact"/&gt; by calling &lt;see cref ="M:FolkerKinzel.Contacts.Contact.Clean"/&gt;, you can create beforehand a copy of &lt;paramref name ="contact"/&gt; with &lt;see cref ="M:FolkerKinzel.Contacts.Contact.Clone"/&gt; and transfer the copy as argument. &lt;/para&gt;
&lt;para&gt;For storing several &lt;see cref ="T:FolkerKinzel.Contacts.Contact"/&gt; objects in a single vcf file the method &lt;see cref ="M:FolkerKinzel.Contacts.IO.ContactPersistence.SaveVCard(System.String,System.Collections.Generic.IEnumerable{FolkerKinzel.Contacts.Contact},FolkerKinzel.Contacts.IO.VCardVersion)"/&gt; is suitable . &lt;/para&gt;</T>
<T ID="49D9F186168423AC">&lt;note type ="important"&gt; For better readability, the examples do not contain any exception handling. &lt;/note&gt; &lt;para&gt; Initializing &lt;see cref ="T:FolkerKinzel.Contacts.Contact"/&gt; objects: &lt;/para &gt; &lt;code/&gt; &lt;para&gt; Read and write vCards (* .vcf): &lt;/para&gt; &lt;code/&gt; &lt;para&gt; Read and write CSV files: &lt;/para&gt; &lt;code/&gt;</T>
<T ID="49D9F186168423AC">&lt;note type ="important"&gt; For the sake of better readability, the examples do not contain any exception handling. &lt;/note&gt; &lt;para&gt; Initializing &lt;see cref ="T:FolkerKinzel.Contacts.Contact"/&gt; objects: &lt;/para &gt; &lt;code/&gt; &lt;para&gt; Reading and writing vCards (* .vcf): &lt;/para&gt; &lt;code/&gt; &lt;para&gt; Reading and writing CSV files: &lt;/para&gt; &lt;code/&gt;</T>
<T ID="D836047E4A123A05">Loads the content of a CSV file as &lt;see cref ="T:System.Collections.Generic.List`1"/&gt; of &lt;see cref ="T:FolkerKinzel.Contacts.Contact"/&gt; objects.</T>
<T ID="6C1C242FC2C16ECB">The method executes &lt;see cref ="M:FolkerKinzel.Contacts.Contact.Clean"/&gt; on each returned &lt;see cref ="T:FolkerKinzel.Contacts.Contact"/&gt; object. Therefore it is usually not necessary to call &lt;see cref ="M:FolkerKinzel.Contacts.Contact.Clean"/&gt; in your own code.</T>
<T ID="78E9ADD96388CE8B">The file path of the CSV file.</T>
Expand Down Expand Up @@ -145,7 +145,6 @@
<T ID="4A0D1E0FFD3AD865"></T>
<T ID="9C1D8DFA5703DD34"></T>
<T ID="5BE8E70ECDD0E627"></T>
<T ID="94419A16D74FCBCB"></T>
<T ID="55330A5A32DE2369"></T>
<T ID="48AB89A4D1E0AAAB"></T>
<T ID="F6F44B02D20AE911"></T>
Expand All @@ -167,4 +166,5 @@
<T ID="3368633987FCA7D1"></T>
<T ID="F62B5BBAC333693A"></T>
<T ID="12EC6D45E2C8FDCF"></T>
<T ID="94419A16C46C7EAE"></T>
</Tsltn>
Binary file not shown.
Binary file not shown.
14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,13 +30,13 @@ F# Interactive:

## Example Code
_(For better readability exception handling is ommitted in the following examples.)_
_(For the sake of better readability exception handling is ommitted in the following examples.)_

* [Example: Initialize Contact Objects](#initialize-contact-objects)
* [Example: Read and Write VCF Files](#read-and-write-vcf-files)
* [Example: Read and Write CSV Files](#read-and-write-csv-files)
* [Example: Initializing Contact Objects](#initializing-contact-objects)
* [Example: Reading and Writing VCF Files](#reading-and-writing-vcf-files)
* [Example: Reading and Writing CSV Files](#reading-and-writing-csv-files)

#### Initialize `Contact` Objects:
#### Initializing `Contact` Objects:
```csharp
using FolkerKinzel.Contacts;
using System;
Expand Down Expand Up @@ -124,7 +124,7 @@ namespace Examples
}
```

#### Read and Write VCF Files:
#### Reading and Writing VCF Files:
```csharp
using FolkerKinzel.Contacts;
using FolkerKinzel.Contacts.IO;
Expand Down Expand Up @@ -241,7 +241,7 @@ Company Data:
*/
```

#### Read and Write CSV Files:
#### Reading and Writing CSV Files:
```csharp
using FolkerKinzel.Contacts;
using FolkerKinzel.Contacts.IO;
Expand Down
4 changes: 2 additions & 2 deletions Reference.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
FolkerKinzel.Contacts.IO
.NET-API to manage contact data of organizations and natural persons, including a data model and classes to persist it as vCard (*.vcf) or CSV.

* [Download Reference (English)](https://github.com/FolkerKinzel/Contacts.IO/blob/master/ProjectReference/1.2.2/FolkerKinzel.Contacts.IO.en.chm)
* [Download Reference (English)](https://github.com/FolkerKinzel/Contacts.IO/blob/master/ProjectReference/1.3.0-beta/FolkerKinzel.Contacts.IO.en.chm)

* [Projektdokumentation (Deutsch) herunterladen](https://github.com/FolkerKinzel/Contacts.IO/blob/master/ProjectReference/1.2.2/FolkerKinzel.Contacts.IO.de.chm)
* [Projektdokumentation (Deutsch) herunterladen](https://github.com/FolkerKinzel/Contacts.IO/blob/master/ProjectReference/1.3.0-beta/FolkerKinzel.Contacts.IO.de.chm)

> IMPORTANT: On some systems, the content of the CHM file is blocked. Before opening the file right click on the file icon, select Properties, and check the "Allow" checkbox - if it is present - in the lower right corner of the General tab in the Properties dialog.

0 comments on commit be03566

Please sign in to comment.