From b2da2d6848293f107014afed5ad8ae0aad799ac2 Mon Sep 17 00:00:00 2001 From: Tig Date: Wed, 17 Apr 2024 08:37:11 -0600 Subject: [PATCH] API doc improvements --- Terminal.Gui/View/Layout/PosDim.cs | 28 ++++++++++++++++------------ 1 file changed, 16 insertions(+), 12 deletions(-) diff --git a/Terminal.Gui/View/Layout/PosDim.cs b/Terminal.Gui/View/Layout/PosDim.cs index 4941f1363..4438fb844 100644 --- a/Terminal.Gui/View/Layout/PosDim.cs +++ b/Terminal.Gui/View/Layout/PosDim.cs @@ -317,12 +317,15 @@ public class Pos public static Pos Y (View view) { return new PosView (view, Side.Y); } /// - /// Used to calculate a position that is anchored to a certain point in the layout. This method is typically used internally by the layout system to determine where a View should be positioned. + /// Gets a position that is anchored to a certain point in the layout. This method is typically used + /// internally by the layout system to determine where a View should be positioned. /// /// The width of the area where the View is being positioned (Superview.ContentSize). - /// An integer representing the calculated position. The way this position is calculated depends on the specific - /// subclass of Pos that is used. For example, PosAbsolute returns a fixed position, PosAnchorEnd returns a - /// position that is anchored to the end of the layout, and so on. + /// + /// An integer representing the calculated position. The way this position is calculated depends on the specific + /// subclass of Pos that is used. For example, PosAbsolute returns a fixed position, PosAnchorEnd returns a + /// position that is anchored to the end of the layout, and so on. + /// internal virtual int Anchor (int width) { return 0; } /// @@ -337,10 +340,10 @@ public class Pos /// Obsolete; to be deprecated. /// Obsolete; to be deprecated. /// - /// The calculated position of the View. The way this position is calculated depends on the specific subclass of Pos that + /// The calculated position of the View. The way this position is calculated depends on the specific subclass of Pos + /// that /// is used. /// - internal virtual int Calculate (int superviewDimension, Dim dim, int autosize, bool autoSize) { return Anchor (superviewDimension); } internal class PosAbsolute (int n) : Pos @@ -691,14 +694,15 @@ public class Dim public static Dim Width (View view) { return new DimView (view, Side.Width); } /// - /// Used to calculate a dimension that is anchored to a certain point in the layout. - /// This method is typically used internally by the layout system to determine the size of a View. + /// Gets a dimension that is anchored to a certain point in the layout. + /// This method is typically used internally by the layout system to determine the size of a View. /// /// The width of the area where the View is being sized (Superview.ContentSize). - /// An integer representing the calculated dimension. The way this dimension is calculated depends on the specific - /// subclass of Dim that is used. For example, DimAbsolute returns a fixed dimension, DimFactor returns a - /// dimension that is a certain percentage of the super view's size, and so on. - + /// + /// An integer representing the calculated dimension. The way this dimension is calculated depends on the specific + /// subclass of Dim that is used. For example, DimAbsolute returns a fixed dimension, DimFactor returns a + /// dimension that is a certain percentage of the super view's size, and so on. + /// internal virtual int Anchor (int width) { return 0; } ///