Skip to content

Commit

Permalink
added in code comments
Browse files Browse the repository at this point in the history
  • Loading branch information
Dirkster99 committed Feb 28, 2020
1 parent 6fcac67 commit 2dcc97c
Show file tree
Hide file tree
Showing 10 changed files with 45 additions and 6 deletions.
9 changes: 8 additions & 1 deletion source/Components/AvalonDock/Controls/AnchorablePaneTitle.cs
Original file line number Diff line number Diff line change
Expand Up @@ -15,14 +15,21 @@ This program is provided to you under the terms of the Microsoft Public

namespace AvalonDock.Controls
{
/// <summary>
/// This control defines the Title area of a <see cref="LayoutAnchorableControl"/>.
/// It is used to show a title bar with docking window buttons to let users interact
/// with a <see cref="LayoutAnchorable"/> via drop down menu click or drag & drop.
/// </summary>
public class AnchorablePaneTitle : Control
{
#region fields
private bool _isMouseDown = false;
#endregion fields

#region Constructors

/// <summary>
/// Static class constructor
/// </summary>
static AnchorablePaneTitle()
{
IsHitTestVisibleProperty.OverrideMetadata(typeof(AnchorablePaneTitle), new FrameworkPropertyMetadata(true));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,9 @@ namespace AvalonDock.Controls
public class LayoutDocumentControl : Control
{
#region Constructors

/// <summary>
/// Static class constructor
/// </summary>
static LayoutDocumentControl()
{
DefaultStyleKeyProperty.OverrideMetadata(typeof(LayoutDocumentControl), new FrameworkPropertyMetadata(typeof(LayoutDocumentControl)));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -32,12 +32,17 @@ public class LayoutDocumentFloatingWindowControl : LayoutFloatingWindowControl,
#endregion fields

#region Constructors

/// <summary>Static class constructor</summary>
static LayoutDocumentFloatingWindowControl()
{
DefaultStyleKeyProperty.OverrideMetadata(typeof(LayoutDocumentFloatingWindowControl), new FrameworkPropertyMetadata(typeof(LayoutDocumentFloatingWindowControl)));
}

/// <summary>
/// Class constructor
/// </summary>
/// <param name="model"></param>
/// <param name="isContentImmutable"></param>
internal LayoutDocumentFloatingWindowControl(LayoutDocumentFloatingWindow model, bool isContentImmutable)
: base(model, isContentImmutable)
{
Expand All @@ -48,6 +53,10 @@ internal LayoutDocumentFloatingWindowControl(LayoutDocumentFloatingWindow model,
UpdateThemeResources();
}

/// <summary>
/// Class constructor
/// </summary>
/// <param name="model"></param>
internal LayoutDocumentFloatingWindowControl(LayoutDocumentFloatingWindow model)
: this(model, false)
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ This program is provided to you under the terms of the Microsoft Public

namespace AvalonDock.Layout
{
/// <summary>Defines an API for interacting with (selected) content in a pane.</summary>
public interface ILayoutContentSelector
{
#region Properties
Expand Down
3 changes: 3 additions & 0 deletions source/Components/AvalonDock/Layout/LayoutAnchorGroup.cs
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,9 @@ This program is provided to you under the terms of the Microsoft Public

namespace AvalonDock.Layout
{
/// <summary>
/// Implements the layout model for the <see cref="Controls.LayoutAnchorGroupControl"/>.
/// </summary>
[ContentProperty(nameof(Children))]
[Serializable]
public class LayoutAnchorGroup : LayoutGroup<LayoutAnchorable>, ILayoutPreviousContainer, ILayoutPaneSerializable
Expand Down
8 changes: 7 additions & 1 deletion source/Components/AvalonDock/Layout/LayoutContent.cs
Original file line number Diff line number Diff line change
Expand Up @@ -19,12 +19,18 @@ This program is provided to you under the terms of the Microsoft Public

namespace AvalonDock.Layout
{
/// <summary>
/// Provides an abstract base class for common properties and methods of
/// the <see cref="LayoutAnchorable"/> and <see cref="LayoutDocument"/> classes.
/// </summary>
[ContentProperty(nameof(Content))]
[Serializable]
public abstract class LayoutContent : LayoutElement, IXmlSerializable, ILayoutElementForFloatingWindow, IComparable<LayoutContent>, ILayoutPreviousContainer
{
#region Constructors

/// <summary>
/// Class constructor
/// </summary>
internal LayoutContent()
{
}
Expand Down
3 changes: 3 additions & 0 deletions source/Components/AvalonDock/Layout/LayoutDocument.cs
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,9 @@ This program is provided to you under the terms of the Microsoft Public

namespace AvalonDock.Layout
{
/// <summary>
/// Implements the layout model for the <see cref="Controls.LayoutDocumentControl"/>.
/// </summary>
[Serializable]
public class LayoutDocument : LayoutContent
{
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ This program is provided to you under the terms of the Microsoft Public

namespace AvalonDock.Layout
{
/// <summary>Implements the layout model for the <see cref="Controls.LayoutDocumentFloatingWindowControl"/>.</summary>
[ContentProperty(nameof(RootPanel))]
[Serializable]
public class LayoutDocumentFloatingWindow : LayoutFloatingWindow, ILayoutElementWithVisibility
Expand Down
9 changes: 7 additions & 2 deletions source/Components/AvalonDock/Layout/LayoutPanel.cs
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,7 @@ This program is provided to you under the terms of the Microsoft Public

namespace AvalonDock.Layout
{
/// <summary>Implements the layout model for the <see cref="Controls.LayoutPanelControl"/>.</summary>
[ContentProperty(nameof(Children))]
[Serializable]
public class LayoutPanel : LayoutPositionableGroup<ILayoutPanelElement>, ILayoutPanelElement, ILayoutOrientableGroup
Expand All @@ -23,11 +24,13 @@ public class LayoutPanel : LayoutPositionableGroup<ILayoutPanelElement>, ILayout
#endregion fields

#region Constructors

/// <summary>Class constructor</summary>
public LayoutPanel()
{
}

/// <summary>Class constructor</summary>
/// <param name="firstChild"></param>
public LayoutPanel(ILayoutPanelElement firstChild)
{
Children.Add(firstChild);
Expand All @@ -36,7 +39,7 @@ public LayoutPanel(ILayoutPanelElement firstChild)
#endregion Constructors

#region Properties

/// <summary>Gets/sets the orientation for this panel.</summary>
public Orientation Orientation
{
get => _orientation;
Expand All @@ -63,6 +66,7 @@ public override void WriteXml(System.Xml.XmlWriter writer)
base.WriteXml(writer);
}

/// <inheritdoc />
public override void ReadXml(System.Xml.XmlReader reader)
{
if (reader.MoveToAttribute(nameof(Orientation)))
Expand All @@ -71,6 +75,7 @@ public override void ReadXml(System.Xml.XmlReader reader)
}

#if TRACE
/// <inheritdoc />
public override void ConsoleDump(int tab)
{
System.Diagnostics.Trace.Write(new string(' ', tab * 4));
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,8 @@ This program is provided to you under the terms of the Microsoft Public

namespace AvalonDock.Layout
{
/// <summary>Provides a base class for other layout panel models that support a specific class of panel.</summary>
/// <typeparam name="T"></typeparam>
[Serializable]
public abstract class LayoutPositionableGroup<T> : LayoutGroup<T>, ILayoutPositionableElementWithActualSize where T : class, ILayoutElement
{
Expand Down

0 comments on commit 2dcc97c

Please sign in to comment.