unoplatform
/
Uno.SkiaSharp
зеркало из https://github.com/unoplatform/Uno.SkiaSharp.git
1
0
Форкнуть 0
Код Задачи Пакеты Проекты Релизы Вики Активность

Updated some docs

This commit is contained in:
Matthew Leibowitz 2018-05-07 04:13:56 +02:00
Родитель c1dccaba66
Коммит 83b2c00550
Не найден ключ, соответствующий данной подписи
Идентификатор ключа GPG: 00A672181E6BF432
5 изменённых файлов: 73 добавлений и 42 удалений
Показать статистику Скачать Patch файл Скачать Diff файл Показать все файлы Свернуть все файлы

10
docs/en/SkiaSharp/GRGlInterface.xml
Просмотреть файл

@ -328,10 +328,12 @@
<Parameter Name="evas" Type="System.IntPtr" /> <Parameter Name="evas" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="evas">To be added.</param> <param name="evas">The pointer to the Evas_GL object to use.</param>
<summary>To be added.</summary> <summary>Create a <see cref="T:SkiaSharp.GRGlInterface" /> using the Evas OpenGL implementation.</summary>
<returns>To be added.</returns> <returns>Returns the new <see cref="T:SkiaSharp.GRGlInterface" />, or null if one could not be created.</returns>
<remarks>To be added.</remarks> <remarks>
<para></para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="CreateNativeGlInterface"> <Member MemberName="CreateNativeGlInterface">

2
docs/en/SkiaSharp/SKAbstractManagedStream.xml
Просмотреть файл

@ -30,7 +30,7 @@
<Docs> <Docs>
<summary>Creates a new instance of <see cref="T:SkiaSharp.SKAbstractManagedStream" />.</summary> <summary>Creates a new instance of <see cref="T:SkiaSharp.SKAbstractManagedStream" />.</summary>
<remarks> <remarks>
<para /> <para></para>
</remarks> </remarks>
</Docs> </Docs>
</Member> </Member>

42
docs/en/SkiaSharp/SKAbstractManagedWStream.xml
Просмотреть файл

@ -11,7 +11,7 @@
</Base> </Base>
<Interfaces /> <Interfaces />
<Docs> <Docs>
<summary>To be added.</summary> <summary>Represents a <see cref="T:SkiaSharp.SKWStream" /> (a writeable Skia stream).</summary>
<remarks>To be added.</remarks> <remarks>To be added.</remarks>
</Docs> </Docs>
<Members> <Members>
@ -26,8 +26,10 @@
</AssemblyInfo> </AssemblyInfo>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added.</summary> <summary>Creates a new instance of <see cref="T:SkiaSharp.SKAbstractManagedWStream" />.</summary>
<remarks>To be added.</remarks> <remarks>
<para></para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -43,9 +45,11 @@
<Parameter Name="owns" Type="System.Boolean" /> <Parameter Name="owns" Type="System.Boolean" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="owns">To be added.</param> <param name="owns">The value indicating whether this object should destroy the underlying native object.</param>
<summary>To be added.</summary> <summary>Creates a new instance of <see cref="T:SkiaSharp.SKAbstractManagedWStream" />.</summary>
<remarks>To be added.</remarks> <remarks>
<para></para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Dispose"> <Member MemberName="Dispose">
@ -83,9 +87,11 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added.</summary> <summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedWStream" /> types to specify the number of bytes currently written to the stream.</summary>
<returns>To be added.</returns> <returns>Returns the number of bytes currently written to the stream.</returns>
<remarks>To be added.</remarks> <remarks>
<para></para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="OnFlush"> <Member MemberName="OnFlush">
@ -102,8 +108,10 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added.</summary> <summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedWStream" /> types to flush the bytes to the underlying stream.</summary>
<remarks>To be added.</remarks> <remarks>
<para></para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="OnWrite"> <Member MemberName="OnWrite">
@ -123,11 +131,13 @@
<Parameter Name="size" Type="System.IntPtr" /> <Parameter Name="size" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="buffer">To be added.</param> <param name="buffer">The buffer to copy into the underlying stream.</param>
<param name="size">To be added.</param> <param name="size">The number of buytes to copy from the buffer.</param>
<summary>To be added.</summary> <summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedWStream" /> types to copy the specified number of bytes from the specified buffer into the underlying stream.</summary>
<returns>To be added.</returns> <returns>Returns <see langword="true" /> on success, otherwise <see langword="false" />.</returns>
<remarks>To be added.</remarks> <remarks>
<para></para>
</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

35
docs/en/SkiaSharp/SKAutoCoInitialize.xml
Просмотреть файл

@ -15,8 +15,11 @@
</Interface> </Interface>
</Interfaces> </Interfaces>
<Docs> <Docs>
<summary>To be added.</summary> <summary>Convenience class used to automatically initialize and uninitialize COM on supported platforms.</summary>
<remarks>To be added.</remarks> <remarks>
<para>This is only supported on Windows, and is usually not needed. However, when creating a .NET Core app, COM may not be initialized.</para>
<para>Currently, only <see cref="T:SkiaSharp.SKDocument" /> and more specifically, XPS documents require COM.</para>
</remarks>
</Docs> </Docs>
<Members> <Members>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -30,8 +33,10 @@
</AssemblyInfo> </AssemblyInfo>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added.</summary> <summary>Initializes COM.</summary>
<remarks>To be added.</remarks> <remarks>
<para></para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Dispose"> <Member MemberName="Dispose">
@ -51,8 +56,10 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added.</summary> <summary>Uninitializes COM.</summary>
<remarks>To be added.</remarks> <remarks>
<para></para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Initialized"> <Member MemberName="Initialized">
@ -68,9 +75,13 @@
<ReturnType>System.Boolean</ReturnType> <ReturnType>System.Boolean</ReturnType>
</ReturnValue> </ReturnValue>
<Docs> <Docs>
<summary>To be added.</summary> <summary>Gets a value indicating whether COM is initialized or not.</summary>
<value>To be added.</value> <value>
<remarks>To be added.</remarks> <para />
</value>
<remarks>
<para />
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Uninitialize"> <Member MemberName="Uninitialize">
@ -87,8 +98,10 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added.</summary> <summary>Uninitializes COM.</summary>
<remarks>To be added.</remarks> <remarks>
<para />
</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

26
docs/en/SkiaSharp/SKManagedWStream.xml
Просмотреть файл

@ -103,9 +103,11 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added.</summary> <summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedWStream" /> types to specify the number of bytes currently written to the stream.</summary>
<returns>To be added.</returns> <returns>Returns the number of bytes currently written to the stream.</returns>
<remarks>To be added.</remarks> <remarks>
<para />
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="OnFlush"> <Member MemberName="OnFlush">
@ -122,8 +124,10 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added.</summary> <summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedWStream" /> types to flush the bytes to the underlying stream.</summary>
<remarks>To be added.</remarks> <remarks>
<para></para>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="OnWrite"> <Member MemberName="OnWrite">
@ -143,11 +147,13 @@
<Parameter Name="size" Type="System.IntPtr" /> <Parameter Name="size" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<param name="buffer">To be added.</param> <param name="buffer">The buffer to copy into the underlying stream.</param>
<param name="size">To be added.</param> <param name="size">The number of buytes to copy from the buffer.</param>
<summary>To be added.</summary> <summary>Implemented by derived <see cref="T:SkiaSharp.SKAbstractManagedWStream" /> types to copy the specified number of bytes from the specified buffer into the underlying stream.</summary>
<returns>To be added.</returns> <returns>Returns <see langword="true" /> on success, otherwise <see langword="false" />.</returns>
<remarks>To be added.</remarks> <remarks>
<para />
</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>