Skip to content
This repository was archived by the owner on May 29, 2024. It is now read-only.

Existing Android content, with remarks removed and docfx configured #8

Merged
merged 44 commits into from
Apr 11, 2019
Merged

Existing Android content, with remarks removed and docfx configured #8

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
44 commits
Select commit Hold shift + click to select a range
314791d
Stripped remarks
lobrien Feb 1, 2019
dbc632b
Initial commit of OPS config files
lobrien Feb 2, 2019
a28d291
tweaks to config
conceptdev Feb 9, 2019
b46e01d
add docfx and breadcrumb
conceptdev Feb 9, 2019
e534579
add default filter
conceptdev Feb 9, 2019
f121009
customize filter
conceptdev Feb 9, 2019
9f4787d
remove temp filters
conceptdev Feb 9, 2019
bd48a54
mdoc update v8.1
lobrien Feb 9, 2019
cfe1173
Removed remarks
lobrien Feb 9, 2019
4ec40b3
build folder tweaks
conceptdev Feb 9, 2019
b2c1cea
Re-ran remarks removal
lobrien Feb 21, 2019
d519581
Merge pull request #7 from xamarin/lobrien-edits-crdun-lkg
conceptdev Mar 26, 2019
20a3737
Merge branch 'master' into crdun-lkg
conceptdev Mar 26, 2019
9e3aa55
Cref compression
lobrien Mar 27, 2019
504af3f
Replaced from response file
lobrien Mar 27, 2019
7cbb434
Fixes NoType crefs that are type only and full reference path
lobrien Mar 28, 2019
fa76f2e
Straight replacements
lobrien Mar 28, 2019
62f79be
Missing args
lobrien Mar 28, 2019
47d478f
Capitalization crefs easily mapped
lobrien Mar 29, 2019
545a6d6
NoType sweep
lobrien Mar 30, 2019
f5859b9
2 fixes
lobrien Mar 30, 2019
332a33f
NoType -> Search
lobrien Apr 2, 2019
1491bb9
Delete NoType crefs that were from Exception spec
lobrien Apr 2, 2019
0de40d6
Replace known bad crefs with search string
lobrien Apr 2, 2019
e3ef5f5
Attribution boilerplate
lobrien Apr 2, 2019
ff7e80f
xref -> query
lobrien Apr 2, 2019
850e899
Links to original documentation
lobrien Apr 3, 2019
c498d6d
Hand fixes for broken xrefs in OPS report
lobrien Apr 3, 2019
0b5c844
Unwrap see elements
lobrien Apr 3, 2019
289580e
remove duplicated https
lobrien Apr 3, 2019
236831c
s/https://https:///https://
lobrien Apr 3, 2019
f588f95
https for creative commons
lobrien Apr 3, 2019
4e52c0c
Merge pull request #10 from xamarin/lobrien-compressed_cref_args
conceptdev Apr 3, 2019
351b642
handedits
lobrien Apr 5, 2019
9455383
If list or table, convert to TBA
lobrien Apr 5, 2019
c5412d5
If “example” in summary -> TBA
lobrien Apr 5, 2019
f351d0c
Manual edits of summaries > 1500 chars
lobrien Apr 5, 2019
37bf6ac
Javadoc to Mdoc First Sentence Plus Length Limit
lobrien Apr 9, 2019
ae8c70d
Merge pull request #12 from xamarin/lobrien-trim-summaries
conceptdev Apr 10, 2019
20e6902
Merge formatting, clobber trim-run
lobrien Apr 10, 2019
6df9bf2
LongSummariesForJavadocToMdoc
lobrien Apr 10, 2019
720421d
FirstSentenceInLongSummaries
lobrien Apr 10, 2019
fcb06a3
Summaries starting with confusing html
lobrien Apr 10, 2019
890ea8a
Merge pull request #13 from xamarin/lobrien-trim-summaries
conceptdev Apr 11, 2019
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
Prev Previous commit
Next Next commit
Summaries starting with confusing html
  • Loading branch information
@lobrien
lobrien committed Apr 10, 2019
commit fcb06a3a1393f1a08db9618a94f6cad4d1573ccc
52 changes: 2 additions & 50 deletions docs/Mono.Android/en/Android.Hardware.Camera2/CameraCharacteristics.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -186,34 +186,7 @@
<ReturnType>Android.Hardware.Camera2.CameraCharacteristics+Key</ReturnType>
</ReturnValue>
<Docs>
<summary>
<list type="bullet">
<item>
<term>This list will always include (30, 30).</term>
</item>
<item>
<term>Also, for constant-framerate recording, for each normal
<see cref="T:Android.Media.CamcorderProfile" /> that has
<see cref="P:Android.Media.CamcorderProfile.Quality" /> in
the range [<format type="text/html"><a href="https://docs.microsoft.com/en-us/search/index?search='Android Media CamcorderProfile QUALITY_LOW';scope=Xamarin" title="Android.Media.CamcorderProfile.QUALITY_LOW">Android.Media.CamcorderProfile.QUALITY_LOW</a></format>,
<format type="text/html"><a href="https://docs.microsoft.com/en-us/search/index?search='Android Media CamcorderProfile QUALITY_2160P';scope=Xamarin" title="Android.Media.CamcorderProfile.QUALITY_2160P">Android.Media.CamcorderProfile.QUALITY_2160P</a></format>], if the profile is
supported by the device and has
<see cref="P:Android.Media.CamcorderProfile.VideoFrameRate" /><c>x</c>, this list will
always include (<c>x</c>,<c>x</c>).</term>
</item>
<item>
<term>For preview streaming use case, this list will always include (<c>min</c>, <c>max</c>) where
<c>min</c> &lt;= 15 and <c>max</c> &gt;= 30.</term>
</item>
</list>
<list type="bullet">
<item>
<term>For YUV_420_888 burst capture use case, this list will always include (<c>min</c>, <c>max</c>)
and (<c>max</c>, <c>max</c>) where <c>min</c> &lt;= 15 and <c>max</c> = the maximum output frame rate of the
maximum YUV_420_888 output size.</term>
</item>
</list>
</summary>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
Expand Down Expand Up @@ -1305,28 +1278,7 @@
<ReturnType>Android.Hardware.Camera2.CameraCharacteristics+Key</ReturnType>
</ReturnValue>
<Docs>
<summary>
<list type="bullet">
<item>
<term>
<see cref="F:Android.Graphics.ImageFormat.Yuv420888" />
</term>
</item>
<item>
<term>
<see cref="F:Android.Graphics.ImageFormat.Nv21" />
</term>
</item>
<item>
<term>
<see cref="F:Android.Graphics.ImageFormat.Yv12" />
</term>
</item>
<item>
<term>Implementation-defined formats, i.e. <format type="text/html"><a href="https://docs.microsoft.com/en-us/search/index?search='Android Hardware Camera2 Params StreamConfigurationMap isOutputSupportedFor(java lang Class T )';scope=Xamarin" title="Android.Hardware.Camera2.Params.StreamConfigurationMap.isOutputSupportedFor(java.lang.Class T )">Android.Hardware.Camera2.Params.StreamConfigurationMap.isOutputSupportedFor(java.lang.Class T )</a></format></term>
</item>
</list>
</summary>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
Expand Down
48 changes: 2 additions & 46 deletions docs/Mono.Android/en/Android.Media.Effect/EffectFactory.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -342,33 +342,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
<format type="text/html">
<table>
<tr>
<td>Parameter name</td>
<td>Meaning</td>
<td>Valid values</td>
</tr>
<tr>
<td>
<c>first_color</c>
</td>
<td>The first color tone.</td>
<td>Integer, representing an ARGB color with 8 bits per channel. May be created using
<format type="text/html"><a href="https://docs.microsoft.com/en-us/search/index?search='T:Android Graphics _Color';scope=Xamarin" title="T:Android.Graphics._Color">T:Android.Graphics._Color</a></format> class.</td>
</tr>
<tr>
<td>
<c>second_color</c>
</td>
<td>The second color tone.</td>
<td>Integer, representing an ARGB color with 8 bits per channel. May be created using
<format type="text/html"><a href="https://docs.microsoft.com/en-us/search/index?search='T:Android Graphics _Color';scope=Xamarin" title="T:Android.Graphics._Color">T:Android.Graphics._Color</a></format> class.</td>
</tr>
</table>
</format>
</summary>
<summary>To be added.</summary>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down Expand Up @@ -789,25 +763,7 @@
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>
<format type="text/html">
<table>
<tr>
<td>Parameter name</td>
<td>Meaning</td>
<td>Valid values</td>
</tr>
<tr>
<td>
<c>tint</c>
</td>
<td>The color of the tint.</td>
<td>Integer, representing an ARGB color with 8 bits per channel. May be created using
<format type="text/html"><a href="https://docs.microsoft.com/en-us/search/index?search='T:Android Graphics _Color';scope=Xamarin" title="T:Android.Graphics._Color">T:Android.Graphics._Color</a></format> class.</td>
</tr>
</table>
</format>
</summary>
<summary>To be added.</summary>
<remarks>
<para>Portions of this page are modifications based on work created and shared by the <format type="text/html"><a href="https://developers.google.com/terms/site-policies" title="Android Open Source Project">Android Open Source Project</a></format> and used according to terms described in the <format type="text/html"><a href="https://creativecommons.org/licenses/by/2.5/" title="Creative Commons 2.5 Attribution License">Creative Commons 2.5 Attribution License.</a></format></para>
</remarks>
Expand Down
5 changes: 1 addition & 4 deletions docs/Mono.Android/en/Android.Net.Wifi/WpsInfo.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,10 +27,7 @@
</Attribute>
</Attributes>
<Docs since="14">
<summary tool="true">A class representing Wi-Fi Protected Setup


<format type="text/html"><h5 class="jd-tagtitle">See Also</h5></format><list type="bullet"><item><term><format type="text/html"><a href="http://developer.android.com/reference/../">ERROR(/WifiP2pConfig)</a></format></term></item></list></summary>
<summary tool="true">To be added.</summary>
<remarks>
<para>
<format type="text/html">
Expand Down
138 changes: 1 addition & 137 deletions docs/Mono.Android/en/Android.OS/AsyncTask.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,143 +20,7 @@
</Attribute>
</Attributes>
<Docs since="3">
<summary tool="true">
<format type="text/html">
<h3>Developer Guides</h3>
</format>
<format type="text/html">
<h2>Usage</h2>
</format>
<example>
<code lang="java">
private class DownloadFilesTask extends AsyncTask&lt;URL, Integer, Long&gt; {
protected Long doInBackground(URL... urls) {
int count = urls.length;
long totalSize = 0;
for (int i = 0; i </code>
</example>
<example>
<code lang="java">
new DownloadFilesTask().execute(url1, url2, url3);
</code>
</example>
<format type="text/html">
<h2>AsyncTask's generic types</h2>
</format>
<list type="number">
<item>
<term>
<c>Params</c>, the type of the parameters sent to the task upon
execution.</term>
</item>
<item>
<term>
<c>Progress</c>, the type of the progress units published during
the background computation.</term>
</item>
<item>
<term>
<c>Result</c>, the type of the result of the background
computation.</term>
</item>
</list>
<example>
<code lang="java">
private class MyTask extends AsyncTask&lt;Void, Void, Void&gt; { ... }
</code>
</example>
<format type="text/html">
<h2>The 4 steps</h2>
</format>
<list type="number">
<item>
<term>
<format type="text/html">
<a href="https://docs.microsoft.com/en-us/search/index?search='Android OS AsyncTask`3 onPreExecute()';scope=Xamarin" title="Android.OS.AsyncTask`3.onPreExecute()">Android.OS.AsyncTask`3.onPreExecute()</a>
</format>, invoked on the UI thread before the task
is executed. This step is normally used to setup the task, for instance by
showing a progress bar in the user interface.</term>
</item>
<item>
<term>
<format type="text/html">
<a href="https://docs.microsoft.com/en-us/search/index?search='M:Android OS AsyncTask`3 DoInBackground';scope=Xamarin" title="M:Android.OS.AsyncTask`3.DoInBackground">M:Android.OS.AsyncTask`3.DoInBackground</a>
</format>, invoked on the background thread
immediately after <format type="text/html"><a href="https://docs.microsoft.com/en-us/search/index?search='Android OS AsyncTask`3 onPreExecute()';scope=Xamarin" title="Android.OS.AsyncTask`3.onPreExecute()">Android.OS.AsyncTask`3.onPreExecute()</a></format> finishes executing. This step is used
to perform background computation that can take a long time. The parameters
of the asynchronous task are passed to this step. The result of the computation must
be returned by this step and will be passed back to the last step. This step
can also use <format type="text/html"><a href="https://docs.microsoft.com/en-us/search/index?search='Android OS AsyncTask`3 publishProgress(Progress )';scope=Xamarin" title="Android.OS.AsyncTask`3.publishProgress(Progress...)">Android.OS.AsyncTask`3.publishProgress(Progress...)</a></format> to publish one or more units
of progress. These values are published on the UI thread, in the
<format type="text/html"><a href="https://docs.microsoft.com/en-us/search/index?search='Android OS AsyncTask`3 onProgressUpdate(Progress )';scope=Xamarin" title="Android.OS.AsyncTask`3.onProgressUpdate(Progress...)">Android.OS.AsyncTask`3.onProgressUpdate(Progress...)</a></format> step.</term>
</item>
<item>
<term>
<format type="text/html">
<a href="https://docs.microsoft.com/en-us/search/index?search='Android OS AsyncTask`3 onProgressUpdate(Progress )';scope=Xamarin" title="Android.OS.AsyncTask`3.onProgressUpdate(Progress...)">Android.OS.AsyncTask`3.onProgressUpdate(Progress...)</a>
</format>, invoked on the UI thread after a
call to <format type="text/html"><a href="https://docs.microsoft.com/en-us/search/index?search='Android OS AsyncTask`3 publishProgress(Progress )';scope=Xamarin" title="Android.OS.AsyncTask`3.publishProgress(Progress...)">Android.OS.AsyncTask`3.publishProgress(Progress...)</a></format>. The timing of the execution is
undefined. This method is used to display any form of progress in the user
interface while the background computation is still executing. For instance,
it can be used to animate a progress bar or show logs in a text field.</term>
</item>
<item>
<term>
<format type="text/html">
<a href="https://docs.microsoft.com/en-us/search/index?search='M:Android OS AsyncTask`3 OnPostExecute';scope=Xamarin" title="M:Android.OS.AsyncTask`3.OnPostExecute">M:Android.OS.AsyncTask`3.OnPostExecute</a>
</format>, invoked on the UI thread after the background
computation finishes. The result of the background computation is passed to
this step as a parameter.</term>
</item>
</list>
<format type="text/html">
<h2>Cancelling a task</h2>
</format>
<format type="text/html">
<h2>Threading rules</h2>
</format>
<list type="bullet">
<item>
<term>The AsyncTask class must be loaded on the UI thread. This is done
automatically as of <format type="text/html"><a href="https://docs.microsoft.com/en-us/search/index?search='F:Android OS Build+VERSION JellyBean';scope=Xamarin" title="F:Android.OS.Build+VERSION.JellyBean">F:Android.OS.Build+VERSION.JellyBean</a></format>.</term>
</item>
<item>
<term>The task instance must be created on the UI thread.</term>
</item>
<item>
<term>
<format type="text/html">
<a href="https://docs.microsoft.com/en-us/search/index?search='Android OS AsyncTask`3 execute(Params )';scope=Xamarin" title="Android.OS.AsyncTask`3.execute(Params...)">Android.OS.AsyncTask`3.execute(Params...)</a>
</format> must be invoked on the UI thread.</term>
</item>
<item>
<term>Do not call <format type="text/html"><a href="https://docs.microsoft.com/en-us/search/index?search='Android OS AsyncTask`3 onPreExecute()';scope=Xamarin" title="Android.OS.AsyncTask`3.onPreExecute()">Android.OS.AsyncTask`3.onPreExecute()</a></format>, <format type="text/html"><a href="https://docs.microsoft.com/en-us/search/index?search='M:Android OS AsyncTask`3 OnPostExecute';scope=Xamarin" title="M:Android.OS.AsyncTask`3.OnPostExecute">M:Android.OS.AsyncTask`3.OnPostExecute</a></format>,
<format type="text/html"><a href="https://docs.microsoft.com/en-us/search/index?search='M:Android OS AsyncTask`3 DoInBackground';scope=Xamarin" title="M:Android.OS.AsyncTask`3.DoInBackground">M:Android.OS.AsyncTask`3.DoInBackground</a></format>, <format type="text/html"><a href="https://docs.microsoft.com/en-us/search/index?search='Android OS AsyncTask`3 onProgressUpdate(Progress )';scope=Xamarin" title="Android.OS.AsyncTask`3.onProgressUpdate(Progress...)">Android.OS.AsyncTask`3.onProgressUpdate(Progress...)</a></format> manually.</term>
</item>
<item>
<term>The task can be executed only once (an exception will be thrown if
a second execution is attempted.)</term>
</item>
</list>
<format type="text/html">
<h2>Memory observability</h2>
</format>
<list type="bullet">
<item>
<term>Set member fields in the constructor or <format type="text/html"><a href="https://docs.microsoft.com/en-us/search/index?search='Android OS AsyncTask`3 onPreExecute()';scope=Xamarin" title="Android.OS.AsyncTask`3.onPreExecute()">Android.OS.AsyncTask`3.onPreExecute()</a></format>, and refer to them
in <format type="text/html"><a href="https://docs.microsoft.com/en-us/search/index?search='M:Android OS AsyncTask`3 DoInBackground';scope=Xamarin" title="M:Android.OS.AsyncTask`3.DoInBackground">M:Android.OS.AsyncTask`3.DoInBackground</a></format>.
</term>
</item>
<item>
<term>Set member fields in <format type="text/html"><a href="https://docs.microsoft.com/en-us/search/index?search='M:Android OS AsyncTask`3 DoInBackground';scope=Xamarin" title="M:Android.OS.AsyncTask`3.DoInBackground">M:Android.OS.AsyncTask`3.DoInBackground</a></format>, and refer to them in
<format type="text/html"><a href="https://docs.microsoft.com/en-us/search/index?search='Android OS AsyncTask`3 onProgressUpdate(Progress )';scope=Xamarin" title="Android.OS.AsyncTask`3.onProgressUpdate(Progress...)">Android.OS.AsyncTask`3.onProgressUpdate(Progress...)</a></format> and <format type="text/html"><a href="https://docs.microsoft.com/en-us/search/index?search='M:Android OS AsyncTask`3 OnPostExecute';scope=Xamarin" title="M:Android.OS.AsyncTask`3.OnPostExecute">M:Android.OS.AsyncTask`3.OnPostExecute</a></format>.
</term>
</item>
</list>
<format type="text/html">
<h2>Order of execution</h2>
</format>
</summary>
<summary tool="true">To be added.</summary>
<remarks>
<para>
<format type="text/html">
Expand Down
Loading