Skip to content

Commit bf20e97

Browse files
committed
API doc updats
1 parent 1810cb1 commit bf20e97

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

Terminal.Gui/View/View.Hierarchy.cs

+19-2
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,8 @@ public partial class View // SuperView/SubView hierarchy management (SuperView,
2727
/// Gets this Views SuperView (the View's container), or <see langword="null"/> if this view has not been added as a
2828
/// SubView.
2929
/// </summary>
30+
/// <seealso cref="OnSuperViewChanged"/>
31+
/// <seealso cref="SuperViewChanged"/>
3032
public View? SuperView
3133
{
3234
get => _superView!;
@@ -66,8 +68,10 @@ protected virtual void OnSuperViewChanged (SuperViewChangedEventArgs e) { }
6668
/// <summary>Adds a SubView (child) to this view.</summary>
6769
/// <remarks>
6870
/// <para>
69-
/// The Views that have been added to this view can be retrieved via the <see cref="SubViews"/> property. See also
70-
/// <seealso cref="Remove(View)"/> <seealso cref="RemoveAll"/>
71+
/// The Views that have been added to this view can be retrieved via the <see cref="SubViews"/> property.
72+
/// </para>
73+
/// <para>
74+
/// To check if a View has been added to this View, compare it's <see cref="SuperView"/> property to this View.
7175
/// </para>
7276
/// <para>
7377
/// SubViews will be disposed when this View is disposed. In other-words, calling this method causes
@@ -76,9 +80,17 @@ protected virtual void OnSuperViewChanged (SuperViewChangedEventArgs e) { }
7680
/// <para>
7781
/// Calls/Raises the <see cref="OnSubViewAdded"/>/<see cref="SubViewAdded"/> event.
7882
/// </para>
83+
/// <para>
84+
/// The <see cref="OnSuperViewChanged"/>/<see cref="SuperViewChanged"/> event will be raised on the added View.
85+
/// </para>
7986
/// </remarks>
8087
/// <param name="view">The view to add.</param>
8188
/// <returns>The view that was added.</returns>
89+
/// <seealso cref="Remove(View)"/>
90+
/// <seealso cref="RemoveAll"/>
91+
/// <seealso cref="OnSubViewAdded"/>
92+
/// <seealso cref="SubViewAdded"/>
93+
8294
public virtual View? Add (View? view)
8395
{
8496
if (view is null)
@@ -191,10 +203,15 @@ protected virtual void OnSubViewAdded (View view) { }
191203
/// <para>
192204
/// Calls/Raises the <see cref="OnSubViewRemoved"/>/<see cref="SubViewRemoved"/> event.
193205
/// </para>
206+
/// <para>
207+
/// The <see cref="OnSuperViewChanged"/>/<see cref="SuperViewChanged"/> event will be raised on the removed View.
208+
/// </para>
194209
/// </remarks>
195210
/// <returns>
196211
/// The removed View. <see langword="null"/> if the View could not be removed.
197212
/// </returns>
213+
/// <seealso cref="OnSubViewRemoved"/>
214+
/// <seealso cref="SubViewRemoved"/>"/>
198215
public virtual View? Remove (View? view)
199216
{
200217
if (view is null)

0 commit comments

Comments
 (0)