[Add] GenerateDocumentationFile and improve xmldocs

samatstariongroup · samatstariongroup · commit e41b35d89bcf · 2025-08-11T10:34:03.000+02:00
diff --git a/ECoreNetto.Extensions/ECoreNetto.Extensions.csproj b/ECoreNetto.Extensions/ECoreNetto.Extensions.csproj
@@ -21,7 +21,8 @@
         <NeutralLanguage>en-US</NeutralLanguage>
         <SatelliteResourceLanguages>en-US</SatelliteResourceLanguages>
         <Authors>Sam Gerene</Authors>
-        <PackageTags>Ecore</PackageTags>
+        <PackageTags>Ecore modeltopia</PackageTags>
+        <GenerateDocumentationFile>true</GenerateDocumentationFile>
         <PackageReleaseNotes>
             [Update] to ECoreNetto version 7.0.0
             [Update] to HtmlAgilityPack version 1.11.74
diff --git a/ECoreNetto.Extensions/StructuralFeatureExtensions.cs b/ECoreNetto.Extensions/StructuralFeatureExtensions.cs
@@ -79,7 +79,7 @@ public static EClass QueryClass(this EStructuralFeature eStructuralFeature)
         /// The subject <see cref="EStructuralFeature"/>
         /// </param>
         /// <returns>
-        /// true if <see cref="EStructuralFeature.UpperBound"/> = -1 or > 1, false if not
+        /// true if EStructuralFeature.UpperBound = -1 or > 1, false if not
         /// </returns>
         public static bool QueryIsEnumerable(this EStructuralFeature eStructuralFeature)
         {
@@ -155,7 +155,7 @@ public static bool QueryIsContainment(this EStructuralFeature structuralFeature)
         }
 
         /// <summary>
-        /// Queries whether the <see cref="EStructuralFeature.Name"/> is equal to the name of the containing <see cref="EClass"/>
+        /// Queries whether the EStructuralFeature.Name is equal to the name of the containing <see cref="EClass"/>
         /// </summary>
         /// <param name="structuralFeature">
         /// The subject <see cref="EStructuralFeature"/>
@@ -243,7 +243,7 @@ public static string QueryTypeName(this EStructuralFeature eStructuralFeature)
         /// The subject <see cref="EStructuralFeature"/>
         /// </param>
         /// <returns>
-        /// true if <see cref="EStructuralFeature.LowerBound"/> = 0, false if not
+        /// true if EStructuralFeature.LowerBound = 0, false if not
         /// </returns>
         public static bool QueryIsNullable(this EStructuralFeature eStructuralFeature)
         {
diff --git a/ECoreNetto.HandleBars/ECoreNetto.HandleBars.csproj b/ECoreNetto.HandleBars/ECoreNetto.HandleBars.csproj
@@ -21,7 +21,8 @@
         <NeutralLanguage>en-US</NeutralLanguage>
         <SatelliteResourceLanguages>en-US</SatelliteResourceLanguages>
         <Authors>Sam Gerene</Authors>
-        <PackageTags>Ecore HandleBars</PackageTags>
+        <PackageTags>Ecore HandleBars modeltopia</PackageTags>
+        <GenerateDocumentationFile>true</GenerateDocumentationFile>
         <PackageReleaseNotes>
             [Update] ECoreNetto.Extensions to version 7.0.0
             [Update] Handlebars.Net.Helpers to version 2.4.13
diff --git a/ECoreNetto.Reporting/ECoreNetto.Reporting.csproj b/ECoreNetto.Reporting/ECoreNetto.Reporting.csproj
@@ -21,7 +21,8 @@
         <NeutralLanguage>en-US</NeutralLanguage>
         <SatelliteResourceLanguages>en-US</SatelliteResourceLanguages>
         <Authors>Sam Gerene</Authors>
-        <PackageTags>Ecore HandleBars Reporting</PackageTags>
+        <PackageTags>Ecore HandleBars Reporting modeltopia</PackageTags>
+        <GenerateDocumentationFile>true</GenerateDocumentationFile>
         <PackageReleaseNotes>
             [Update] ECoreNetto.HandleBars version 7.0.0
             [Add] parameter validation
diff --git a/ECoreNetto.Tools/ECoreNetto.Tools.csproj b/ECoreNetto.Tools/ECoreNetto.Tools.csproj
@@ -16,6 +16,8 @@
         <ApplicationIcon>icon.ico</ApplicationIcon>
         <NeutralLanguage>en-US</NeutralLanguage>
         <SatelliteResourceLanguages>en-US</SatelliteResourceLanguages>
+        <PackageTags>Ecore HandleBars Reporting modeltopia</PackageTags>
+        <GenerateDocumentationFile>true</GenerateDocumentationFile>
         <PackageReleaseNotes>
             [Update] to ECoreNetto.Reporting version 7.0.0
             [Add] parameter validation
diff --git a/ECoreNetto/ECoreNetto.csproj b/ECoreNetto/ECoreNetto.csproj
@@ -24,7 +24,8 @@
         <NeutralLanguage>en-US</NeutralLanguage>
         <SatelliteResourceLanguages>en-US</SatelliteResourceLanguages>
         <Authors>Sam Gerene</Authors>
-        <PackageTags>Ecore</PackageTags>
+        <PackageTags>Ecore modeltopia</PackageTags>
+        <GenerateDocumentationFile>true</GenerateDocumentationFile>
         <PackageReleaseNotes>
             [Add] parameter validation
         </PackageReleaseNotes>
diff --git a/ECoreNetto/ModelElement/ENamedElement.cs b/ECoreNetto/ModelElement/ENamedElement.cs
@@ -88,7 +88,7 @@ public override void ReadXml(XmlNode element)
         }
         
         /// <summary>
-        /// Build the <see cref="EModelElement.Identifier"/> property
+        /// Build the EModelElement.Identifier property
         /// </summary>
         /// <returns>
         /// The identifier
diff --git a/ECoreNetto/ModelElement/NamedElement/EClassifier.cs b/ECoreNetto/ModelElement/NamedElement/EClassifier.cs
@@ -95,7 +95,7 @@ internal override void SetProperties()
         }
 
         /// <summary>
-        /// Build the <see cref="EModelElement.Identifier"/> property
+        /// Build the EModelElement.Identifier property
         /// </summary>
         /// <returns>
         /// The identifier
diff --git a/ECoreNetto/ModelElement/NamedElement/EEnumLiteral.cs b/ECoreNetto/ModelElement/NamedElement/EEnumLiteral.cs
@@ -73,7 +73,7 @@ internal override void SetProperties()
         }
 
         /// <summary>
-        /// Build the <see cref="EModelElement.Identifier"/> property
+        /// Build the EModelElement.Identifier property
         /// </summary>
         /// <returns>The identifier</returns>
         protected override string BuildIdentifier()
diff --git a/ECoreNetto/ModelElement/NamedElement/EPackage.cs b/ECoreNetto/ModelElement/NamedElement/EPackage.cs
@@ -188,7 +188,7 @@ protected override void DeserializeChildNode(XmlNode reader)
         }
 
         /// <summary>
-        /// Build the <see cref="EModelElement.Identifier"/> property
+        /// Build the EModelElement.Identifier property
         /// </summary>
         /// <returns>
         /// The identifier
diff --git a/ECoreNetto/ModelElement/NamedElement/TypedElement/EOperation.cs b/ECoreNetto/ModelElement/NamedElement/TypedElement/EOperation.cs
@@ -91,7 +91,7 @@ public bool IsOverrideOf(EOperation someOperation)
         }
 
         /// <summary>
-        /// Build the <see cref="EModelElement.Identifier"/> property
+        /// Build the EModelElement.Identifier property
         /// </summary>
         /// <returns>
         /// The identifier
diff --git a/ECoreNetto/ModelElement/NamedElement/TypedElement/EParameter.cs b/ECoreNetto/ModelElement/NamedElement/TypedElement/EParameter.cs
@@ -46,7 +46,7 @@ public EParameter(Resource.Resource resource, ILoggerFactory loggerFactory = nul
         public EOperation EOperation => (EOperation)this.EContainer;
 
         /// <summary>
-        /// Build the <see cref="EModelElement.Identifier"/> property
+        /// Build the EModelElement.Identifier property
         /// </summary>
         /// <returns>
         /// The identifier
diff --git a/ECoreNetto/ModelElement/NamedElement/TypedElement/EStructuralFeature.cs b/ECoreNetto/ModelElement/NamedElement/TypedElement/EStructuralFeature.cs
@@ -165,7 +165,7 @@ internal override void SetProperties()
         }
 
         /// <summary>
-        /// Build the <see cref="EModelElement.Identifier"/> property
+        /// Build the EModelElement.Identifier property
         /// </summary>
         /// <returns>
         /// The identifier
diff --git a/ECoreNetto/ModelElement/NamedElement/TypedElement/StructuralFeature/EReference.cs b/ECoreNetto/ModelElement/NamedElement/TypedElement/StructuralFeature/EReference.cs
@@ -60,7 +60,7 @@ public EReference(Resource.Resource resource, ILoggerFactory loggerFactory = nul
         /// <remarks>
         /// Containment applies only for references. A containment reference always
         /// has an implicit opposite, even if there is no explicit opposite and that
-        /// opposite is effectively a view on <see cref="EObject.eContainer()"/>.
+        /// opposite is effectively a view on EObject.eContainer().
         /// Whenever an object is added to a containment reference, it will be removed
         /// from any other containment reference currently holding it.
         /// That’s because an object can only have one container,so adding it to a
diff --git a/ECoreNetto/Utils/ContainmentUpdater.cs b/ECoreNetto/Utils/ContainmentUpdater.cs
@@ -163,7 +163,7 @@ private static void RemoveFromContainer(EStructuralFeature structuralFeature)
         }
 
         /// <summary>
-        /// removes the <see cref="EEnumLiteral"/> from its container <see cref=""/>
+        /// removes the <see cref="EEnumLiteral"/> from its container <see cref="EEnum"/>
         /// </summary>
         /// <param name="enumLiteral">
         /// the subject <see cref="EEnum"/>

Original file line number	Diff line number	Diff line change
`@@ -88,7 +88,7 @@ public override void ReadXml(XmlNode element)`
`88`	`88`	`}`
`89`	`89`
`90`	`90`	`/// <summary>`
`91`		`- /// Build the <see cref="EModelElement.Identifier"/> property`
	`91`	`+ /// Build the EModelElement.Identifier property`
`92`	`92`	`/// </summary>`
`93`	`93`	`/// <returns>`
`94`	`94`	`/// The identifier`
Original file line number	Diff line number	Diff line change
`@@ -95,7 +95,7 @@ internal override void SetProperties()`
`95`	`95`	`}`
`96`	`96`
`97`	`97`	`/// <summary>`
`98`		`- /// Build the <see cref="EModelElement.Identifier"/> property`
	`98`	`+ /// Build the EModelElement.Identifier property`
`99`	`99`	`/// </summary>`
`100`	`100`	`/// <returns>`
`101`	`101`	`/// The identifier`
Original file line number	Diff line number	Diff line change
`@@ -73,7 +73,7 @@ internal override void SetProperties()`
`73`	`73`	`}`
`74`	`74`
`75`	`75`	`/// <summary>`
`76`		`- /// Build the <see cref="EModelElement.Identifier"/> property`
	`76`	`+ /// Build the EModelElement.Identifier property`
`77`	`77`	`/// </summary>`
`78`	`78`	`/// <returns>The identifier</returns>`
`79`	`79`	`protected override string BuildIdentifier()`
Original file line number	Diff line number	Diff line change
`@@ -188,7 +188,7 @@ protected override void DeserializeChildNode(XmlNode reader)`
`188`	`188`	`}`
`189`	`189`
`190`	`190`	`/// <summary>`
`191`		`- /// Build the <see cref="EModelElement.Identifier"/> property`
	`191`	`+ /// Build the EModelElement.Identifier property`
`192`	`192`	`/// </summary>`
`193`	`193`	`/// <returns>`
`194`	`194`	`/// The identifier`