​

Author: PDFsharp-Team

README.md

@@ -1,7 +1,7 @@
 # PDFsharp & MigraDoc 6.0
 
-Version **6.0.0-preview-3**  
-Published **2023-07-27**
+Version **6.0.0-preview-4**  
+Published **2023-10-11**
 
 This is the third preview of the **PDFsharp** project, the main project of PDFsharp & MigraDoc 6.0 with updates for C# 10 and .NET 6.0.
 

dev/run-tests.ps1

@@ -39,6 +39,10 @@ function GetDllInfo($project) {
 
     $debugFolder = Join-Path -Path $projectFolder "bin\debug"
     $dllFile = Get-ChildItem -Path $debugFolder -Filter "$projectName.dll" -Recurse -ErrorAction SilentlyContinue -Force | Select-Object  -first 1
+    
+    if ($dllFile -eq $null) {
+        Write-Error "Could not finde file `"$debugFolder\**\$projectName.dll`". Maybe Debug Build has not been built."
+    }
 
     $dllFolder = $dllFile.Directory.FullName | Resolve-Path -Relative
     $dllFileName = $dllFile.Name

docs/DevNotes.md

@@ -6,19 +6,18 @@
 
 README.md
 
-
 ## Comments
 
 ### DELETE yyyy-mm-dd
 
-Here is code that is replaced by newer code and should be deleted in the future.
-But keeps here at the moment as reference in case the new code has bugs.
+Here is code that was replaced by newer code and should be deleted in the future.
+But kept here at the moment as reference in case the new code has bugs.
 
 After the specified date the code can be deleted.
 
 ### KEEP
 
-Here is older code that is not used anymore but keeps here for 
+Here is older code that is not used anymore but kept here for 
 documentation or reference purposes and shall not be removed.
 
 ### TODO
@@ -36,9 +35,8 @@ for better reliability.
 
 ### OBSERVATION
 
-
 ### EXPERIMENTAL
 
-
 ### TEST
-Here is code that should be coved by (more) unit tests.
+
+Here is code that should be coved by (more) unit tests.

src/foundation/src/MigraDoc/src/MigraDoc.DocumentObjectModel/Capabilities.cs

@@ -76,7 +76,9 @@ public static class BackwardCompatibility
             public static bool DoNotCreateLastTable { get; set; } = false;
 
             /// <summary>
-            /// NYI
+            /// Gets or sets a flag that defines what LastSection does if no section exists.
+            /// If false, which is the default value, a new section is created and returned.
+            /// If true, no section will be created and null is returned instead.
             /// </summary>
             public static bool DoNotCreateLastSection { get; set; } = false;
 

src/foundation/src/MigraDoc/src/MigraDoc.DocumentObjectModel/DocumentObjectModel.IO/DdlScanner.cs

@@ -607,8 +607,7 @@ internal bool MoveToNextParagraphContentLine(bool rootLevel)
                                 return false;
                             }
 
-                            //TODO NiSc
-                            //NYI
+                            //TODO NiSc NYI
                             //Check.NotImplemented("empty line at non-root level");
                         }
                         break;
@@ -743,7 +742,7 @@ internal int GetTokenValueAsInt()
                 string number = _token.Substring(2);
                 return Int32.Parse(number, NumberStyles.AllowHexSpecifier, CultureInfo.InvariantCulture);
             }
-            //TODO NiSc
+            //TODO NiSc Check?
             //Check.Assert(false);
             return 0;
         }
@@ -762,7 +761,7 @@ internal uint GetTokenValueAsUInt()
                 string number = _token.Substring(2);
                 return UInt32.Parse(number, NumberStyles.AllowHexSpecifier, CultureInfo.InvariantCulture);
             }
-            //TODO NiSc
+            //TODO NiSc Check.
             //Check.Assert(false);
             return 0;
         }
@@ -818,7 +817,7 @@ internal char ScanNextChar()
                         }
                         //else
                         //{
-                        //    //TODO NiSc
+                        //    //TOxDO NiSc NYI
                         //    //NYI: MacOS uses CR only
                         //    //Check.NotImplemented();
                         //}

src/foundation/src/MigraDoc/src/MigraDoc.DocumentObjectModel/DocumentObjectModel.Internals/LogMessages.cs

@@ -28,6 +28,7 @@ public static partial void ArgbValueIsConsideredEmptyColor(
         // Differences in RTF vs Word (decimal tab)
         // Performance optimization
 
+        // TODO Use logging instead of Console.WriteLine.
         // TODO remove all Console.WriteLine calls.
     }
 }

src/foundation/src/MigraDoc/src/MigraDoc.DocumentObjectModel/DocumentObjectModel.Internals/Logging.cs

@@ -24,9 +24,9 @@ public static class AppLogEvents
 
         // TODO Not yet used.
 
-        public static EventId FontCreated = new(1000, "Font created");
-        public static EventId FontFound = new(1001, "Font found");
-        public static EventId FontNotFound = new(1002, "Font not found");
+        public static EventId FontCreated = new(AppLogEventIds.MDDOM + 0, "Font created");
+        public static EventId FontFound = new(AppLogEventIds.MDDOM + 1, "Font found");
+        public static EventId FontNotFound = new(AppLogEventIds.MDDOM + 2, "Font not found");
 
 #if DEBUG_
 

src/foundation/src/MigraDoc/src/MigraDoc.DocumentObjectModel/DocumentObjectModel.Shapes.Charts/Axis.cs

@@ -221,7 +221,7 @@ internal override void Serialize(Serializer serializer)
             var chartObject = Parent as Chart;
             Debug.Assert(chartObject != null);
 
-            serializer.WriteLine("\\" + chartObject.CheckAxis(this)); // HACK // BUG: What if Parent is not Chart?
+            serializer.WriteLine("\\" + chartObject.CheckAxis(this)); // Exception if Parent is not Chart. This is by design.
             var pos = serializer.BeginAttributes();
 
             if (Values.MinimumScale is not null)

src/foundation/src/MigraDoc/src/MigraDoc.DocumentObjectModel/DocumentObjectModel.Shapes.Charts/AxisTitle.cs

@@ -123,7 +123,7 @@ internal override void Serialize(Serializer serializer)
             if (Values.Alignment is not null)
                 serializer.WriteSimpleAttribute("Alignment", Alignment);
 
-            if (Values.VerticalAlignment is not null /*&& !Values.VerticalAlignment.IsNull*/) // BUG??? IsNull?
+            if (Values.VerticalAlignment is not null)
                 serializer.WriteSimpleAttribute("VerticalAlignment", VerticalAlignment);
 
             if (Values.Caption is not null)

src/foundation/src/MigraDoc/src/MigraDoc.DocumentObjectModel/DocumentObjectModel.Shapes/Barcode.cs

@@ -76,7 +76,7 @@ public string Code
         }
 
         /// <summary>
-        /// ??? TODO
+        /// Ratio between narrow and wide lines.
         /// </summary>
         public double LineRatio
         {
@@ -85,7 +85,7 @@ public double LineRatio
         }
 
         /// <summary>
-        /// ??? TODO
+        /// Height of lines.
         /// </summary>
         public double LineHeight
         {
@@ -94,7 +94,7 @@ public double LineHeight
         }
 
         /// <summary>
-        /// ??? TODO
+        /// Width of a narrow line.
         /// </summary>
         public double NarrowLineWidth
         {

src/foundation/src/MigraDoc/src/MigraDoc.DocumentObjectModel/DocumentObjectModel.Shapes/WrapFormat.cs

@@ -81,7 +81,7 @@ public Unit DistanceRight
         internal override void Serialize(Serializer serializer)
         {
             if (IsNull())
-                return; // BUG??? Not detected by the caller anymore.
+                return; // IsNull called here so callers must not make this check.
 
             var pos = serializer.BeginContent("WrapFormat");
             if (Values.Style is not null)

src/foundation/src/MigraDoc/src/MigraDoc.DocumentObjectModel/DocumentObjectModel.Tables/Cell.cs

@@ -45,9 +45,9 @@ internal Cell(DocumentObject parent) : base(parent)
         protected override object DeepCopy()
         {
             var cell = (Cell)base.DeepCopy();
-            // Remove all references to the original object hierarchy.
             cell.ResetCachedValues();
-            // TODO Call ResetCachedValues() for all classes where this is needed!
+
+            // Remove all references to the original object hierarchy.
             if (cell.Values.Format != null)
             {
                 cell.Values.Format = cell.Values.Format.Clone();

src/foundation/src/MigraDoc/src/MigraDoc.DocumentObjectModel/DocumentObjectModel.Tables/Table.cs

@@ -128,7 +128,7 @@ public void SetShading(int clm, int row, int clms, int rows, Color clr)
         /// Sets the borders surrounding the specified range of the table.
         /// </summary>
         public void SetEdge(int clm, int row, int clms, int rows,
-          Edge edge, BorderStyle style, Unit width, Color clr)  // TODO: make Color?
+          Edge edge, BorderStyle style, Unit width, Color clr)
         {
             int maxRow = row + rows - 1;
             int maxClm = clm + clms - 1;

src/foundation/src/MigraDoc/src/MigraDoc.DocumentObjectModel/DocumentObjectModel.Visitors/ElementsExtensions.cs

@@ -112,7 +112,7 @@ public static IEnumerable<T> GetElements<T>(this DocumentObject documentObject,
                 yield return element;
 
                 if (element == null) // Null elements have no children.
-                    continue; // BUG Or throw instead?
+                    continue;
 
                 var children = element.GetElementsRecursively(includeHeaderFooter);
                 foreach (var child in children)
@@ -135,7 +135,7 @@ public static IEnumerable<T> GetElements<T>(this DocumentObject documentObject,
             foreach (var element in elements)
             {
                 var type = element?.GetType();
-                var stop = type != null && stopAtElements.Contains(type); // BUG Or throw instead?
+                var stop = type != null && stopAtElements.Contains(type);
 
                 if (stop && !includeStoppingElements)
                     yield break;
@@ -146,7 +146,7 @@ public static IEnumerable<T> GetElements<T>(this DocumentObject documentObject,
                     yield break;
 
                 if (element == null) // Null elements have no children.
-                    continue; // BUG Or throw instead?
+                    continue;
 
                 var children = element.GetElementsRecursively(includeHeaderFooter);
                 foreach (var child in children)