@@ -87,13 +87,16 @@ public long GetLength()
8787 /// </summary>
8888 /// <returns>Returns a pointer to the start of the memory.</returns>
8989 /// <remarks>
90+ /// <para>
9091 /// The pointer may become invalid if the memory grows.
9192 ///
9293 /// This may happen if the memory is explicitly requested to grow or
9394 /// grows as a result of WebAssembly execution.
94- ///
95+ /// </para>
96+ /// <para>
9597 /// Therefore, the returned pointer should not be used after calling the grow method or
9698 /// after calling into WebAssembly code.
99+ /// </para>
97100 /// </remarks>
98101 public unsafe IntPtr GetPointer ( )
99102 {
@@ -107,13 +110,16 @@ public unsafe IntPtr GetPointer()
107110 /// <returns>Returns the span of the memory.</returns>
108111 /// <exception cref="OverflowException">The memory has more than 32767 pages.</exception>
109112 /// <remarks>
113+ /// <para>
110114 /// The span may become invalid if the memory grows.
111115 ///
112116 /// This may happen if the memory is explicitly requested to grow or
113117 /// grows as a result of WebAssembly execution.
114- ///
118+ /// </para>
119+ /// <para>
115120 /// Therefore, the returned span should not be used after calling the grow method or
116121 /// after calling into WebAssembly code.
122+ /// </para>
117123 /// </remarks>
118124 [ Obsolete ( "This method will throw an OverflowException if the memory has more than 32767 pages. " +
119125 "Use the " + nameof ( GetSpan ) + " overload taking an address and a length." ) ]
@@ -129,13 +135,16 @@ public Span<byte> GetSpan()
129135 /// <param name="address">The zero-based address of the start of the span.</param>
130136 /// <param name="length">The length of the span.</param>
131137 /// <remarks>
138+ /// <para>
132139 /// The span may become invalid if the memory grows.
133- ///
140+ ///
134141 /// This may happen if the memory is explicitly requested to grow or
135142 /// grows as a result of WebAssembly execution.
136- ///
143+ /// </para>
144+ /// <para>
137145 /// Therefore, the returned span should not be used after calling the grow method or
138146 /// after calling into WebAssembly code.
147+ /// </para>
139148 /// </remarks>
140149 public Span < byte > GetSpan ( long address , int length )
141150 {
@@ -150,16 +159,20 @@ public Span<byte> GetSpan(long address, int length)
150159 /// <exception cref="OverflowException">The memory exceeds the byte length that can be
151160 /// represented by a <see cref="Span{T}"/>.</exception>
152161 /// <remarks>
162+ /// <para>
153163 /// The span may become invalid if the memory grows.
154164 ///
155165 /// This may happen if the memory is explicitly requested to grow or
156166 /// grows as a result of WebAssembly execution.
157- ///
167+ /// </para>
168+ /// <para>
158169 /// Therefore, the returned span should not be used after calling the grow method or
159170 /// after calling into WebAssembly code.
160- ///
171+ /// </para>
172+ /// <para>
161173 /// Note that WebAssembly always uses little endian as byte order. On platforms
162174 /// that use big endian, you will need to convert numeric values accordingly.
175+ /// </para>
163176 /// </remarks>
164177 public unsafe Span < T > GetSpan < T > ( int address )
165178 where T : unmanaged
@@ -174,16 +187,20 @@ public unsafe Span<T> GetSpan<T>(int address)
174187 /// <param name="address">The zero-based address of the start of the span.</param>
175188 /// <param name="length">The length of the span.</param>
176189 /// <remarks>
190+ /// <para>
177191 /// The span may become invalid if the memory grows.
178192 ///
179193 /// This may happen if the memory is explicitly requested to grow or
180194 /// grows as a result of WebAssembly execution.
181- ///
195+ /// </para>
196+ /// <para>
182197 /// Therefore, the returned span should not be used after calling the grow method or
183198 /// after calling into WebAssembly code.
184- ///
199+ /// </para>
200+ /// <para>
185201 /// Note that WebAssembly always uses little endian as byte order. On platforms
186202 /// that use big endian, you will need to convert numeric values accordingly.
203+ /// </para>
187204 /// </remarks>
188205 public unsafe Span < T > GetSpan < T > ( long address , int length )
189206 where T : unmanaged
@@ -220,8 +237,10 @@ public unsafe Span<T> GetSpan<T>(long address, int length)
220237 /// <param name="address">The zero-based address to read from.</param>
221238 /// <returns>Returns the struct read from memory.</returns>
222239 /// <remarks>
240+ /// <para>
223241 /// Note that WebAssembly always uses little endian as byte order. On platforms
224242 /// that use big endian, you will need to convert numeric values accordingly.
243+ /// </para>
225244 /// </remarks>
226245 public T Read < T > ( long address )
227246 where T : unmanaged
@@ -236,8 +255,10 @@ public T Read<T>(long address)
236255 /// <param name="address">The zero-based address to read from.</param>
237256 /// <param name="value">The struct to write.</param>
238257 /// <remarks>
258+ /// <para>
239259 /// Note that WebAssembly always uses little endian as byte order. On platforms
240260 /// that use big endian, you will need to convert numeric values accordingly.
261+ /// </para>
241262 /// </remarks>
242263 public void Write < T > ( long address , T value )
243264 where T : unmanaged
0 commit comments