Skip to content

Document Android view inspectors #430

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jonathanpeppers wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Document Android view inspectors #430

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 2 additions & 2 deletions docs/xml/Android.Views.Inspectors/InspectionCompanionUninitializedPropertyMapException.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,8 +65,8 @@
</Attributes>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Initializes an exception for attempts to read inspectable properties before their IDs are mapped.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
Expand Down
4 changes: 2 additions & 2 deletions docs/xml/Android.Views.Inspectors/IntFlagMapping.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,8 +71,8 @@
</Attributes>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Initializes an empty mapping of flag values.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Add">
Expand Down
10 changes: 5 additions & 5 deletions docs/xml/Android.Views.Inspectors/PropertyMapperPropertyConflictException.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,11 +89,11 @@
<Parameter Name="existingPropertyType" Type="System.String" />
</Parameters>
<Docs>
<param name="name">To be added.</param>
<param name="newPropertyType">To be added.</param>
<param name="existingPropertyType">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="name">The name of the property being mapped.</param>
<param name="newPropertyType">The type requested for the property.</param>
<param name="existingPropertyType">The type previously mapped for the property.</param>
<summary>Initializes an exception for a property name mapped to incompatible types.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="JniPeerMembers">
Expand Down
22 changes: 11 additions & 11 deletions docs/xml/Android.Views.Inspectors/PropertyReaderPropertyTypeMismatchException.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -89,11 +89,11 @@
<Parameter Name="actualPropertyType" Type="System.String" />
</Parameters>
<Docs>
<param name="id">To be added.</param>
<param name="expectedPropertyType">To be added.</param>
<param name="actualPropertyType">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="id">The identifier of the property that was read.</param>
<param name="expectedPropertyType">The type used to read the property.</param>
<param name="actualPropertyType">The type mapped for the property identifier.</param>
<summary>Initializes an exception for a property identifier read using a type different from its mapped type.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
Expand Down Expand Up @@ -130,12 +130,12 @@
</Parameter>
</Parameters>
<Docs>
<param name="id">To be added.</param>
<param name="expectedPropertyType">To be added.</param>
<param name="actualPropertyType">To be added.</param>
<param name="propertyName">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<param name="id">The identifier of the property that was read.</param>
<param name="expectedPropertyType">The type used to read the property.</param>
<param name="actualPropertyType">The type mapped for the property identifier.</param>
<param name="propertyName">The name of the property, if available.</param>
<summary>Initializes an exception for a property read using a type different from its mapped type.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="JniPeerMembers">
Expand Down
12 changes: 6 additions & 6 deletions docs/xml/Android.Views.Inspectors/StaticInspectionCompanionProvider.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -76,8 +76,8 @@
</Attributes>
<Parameters />
<Docs>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<summary>Initializes a provider that locates companions by the inspectable type's generated companion class name.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
Expand Down Expand Up @@ -173,10 +173,10 @@
<Parameter Name="cls" Type="Java.Lang.Class" />
</Parameters>
<Docs>
<param name="cls">To be added.</param>
<summary>To be added.</summary>
<returns>To be added.</returns>
<remarks>To be added.</remarks>
<param name="cls">The inspectable type whose companion is requested.</param>
<summary>Locates and instantiates the inspection companion class associated with an inspectable type.</summary>
<returns>The inspection companion, or <see langword="null" /> when no compatible companion class is found.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="ThresholdClass">
Expand Down
2 changes: 1 addition & 1 deletion docs/xml/Android.Views.Inspectors/WindowInspector.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -66,7 +66,7 @@
<ReturnType>System.Collections.Generic.IList&lt;Android.Views.View&gt;</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<summary>Gets the window views attached to the current process.</summary>
<value>the list of all window views attached to the current process</value>
<remarks>
<para>
Expand Down