Regenerate the docs (#541)

* Update the build bits for the new things * Re-generate the docs
xamarin · Oct 9, 2018 · 50e4410 · 50e4410
1 parent 47d6c0c
commit 50e4410
Show file tree

Hide file tree

Showing 25 changed files with 679 additions and 97 deletions.
diff --git a/Xamarin.Essentials/AssemblyInfo/AssemblyInfo.shared.cs b/Xamarin.Essentials/AssemblyInfo/AssemblyInfo.shared.cs
@@ -1,7 +1,7 @@
 using System.Runtime.CompilerServices;
 
 [assembly: InternalsVisibleTo("XamarinEssentialsTests")]
-[assembly: InternalsVisibleTo("XamarinEssentialsDeviceTestsiOS.Android")]
+[assembly: InternalsVisibleTo("XamarinEssentialsDeviceTestsAndroid")]
 [assembly: InternalsVisibleTo("XamarinEssentialsDeviceTestsUWP")]
 [assembly: InternalsVisibleTo("XamarinEssentialsDeviceTestsShared")]
 [assembly: InternalsVisibleTo("XamarinEssentialsDeviceTestsiOS")]
diff --git a/Xamarin.Essentials/Xamarin.Essentials.csproj b/Xamarin.Essentials/Xamarin.Essentials.csproj
@@ -54,7 +54,7 @@
   </ItemGroup>
   <ItemGroup>
     <None Include="..\nugetreadme.txt" PackagePath="readme.txt" Pack="true" />
-    <PackageReference Include="mdoc" Version="5.7.2" PrivateAssets="All" />
+    <PackageReference Include="mdoc" Version="5.7.3.4" PrivateAssets="All" />
     <PackageReference Include="MSBuild.Sdk.Extras" Version="1.6.46" PrivateAssets="All" />
     <PackageReference Include="System.Numerics.Vectors" Version="4.5.0" />
     <Compile Include="**\*.shared.cs" />

diff --git a/Xamarin.Essentials/mdoc.targets b/Xamarin.Essentials/mdoc.targets
@@ -92,7 +92,7 @@
     <MakeDir Directories="$(TmpDir)" />
     <Copy SourceFiles="$(MDocDocumentationDirectory)\..\frameworks.xml" DestinationFolder="$(TmpDir)" />
     <Copy SourceFiles="$(BinConfigDir)netstandard2.0\$(AssemblyName).dll" DestinationFolder="$(TmpDir)xamarin-essentials" />
-    <Copy SourceFiles="$(BinConfigDir)monoandroid81\$(AssemblyName).dll" DestinationFolder="$(TmpDir)xamarin-essentials-android" />
+    <Copy SourceFiles="$(BinConfigDir)monoandroid81\MonoAndroid81\$(AssemblyName).dll" DestinationFolder="$(TmpDir)xamarin-essentials-android" />
     <Copy SourceFiles="$(BinConfigDir)xamarin.ios10\$(AssemblyName).dll" DestinationFolder="$(TmpDir)xamarin-essentials-ios" />
     <Copy SourceFiles="$(BinConfigDir)uap10.0.16299\$(AssemblyName).dll" DestinationFolder="$(TmpDir)xamarin-essentials-uwp" />
     <Exec Command="$(_ManagedExeLauncher) &quot;$(MDocToolPath)&quot; update -lang=DocId --delete --frameworks=&quot;$(TmpDir)frameworks.xml&quot; --out=&quot;$(MDocDocumentationDirectory)&quot; $(MDocReferenceAssemblies)" />
@@ -110,6 +110,7 @@
   -->
   <Target Name="MDocVerifyDocs"
           DependsOnTargets="_MDocSetup">
+    <_FormatDocs DocsRoot="$(MDocDocumentationDirectory)" />
     <_VerifyAllDocsAreComplete DocsRoot="$(MDocDocumentationDirectory)" />
   </Target>
 
@@ -132,6 +133,32 @@
       <Code Type="Fragment" Language="cs"><![CDATA[
         foreach (var file in Directory.EnumerateFiles(DocsRoot, "*.xml", SearchOption.AllDirectories)) {
           var xdoc = XDocument.Load(file);
+
+          // special case for Android resources: don't process
+          if (xdoc.Root.Name == "Type") {
+            var nameAttr = xdoc.Root.Attribute("FullName");
+            if (nameAttr != null && (nameAttr.Value == "Xamarin.Essentials.Resource" || nameAttr.Value.StartsWith("Xamarin.Essentials.Resource+"))) {
+              File.Delete(file);
+              continue;
+            }
+          }
+          if (xdoc.Root.Name == "Overview") {
+            foreach (var type in xdoc.Root.Descendants("Type").ToArray()) {
+              var nameAttr = type.Attribute("Name");
+              if (nameAttr != null && (nameAttr.Value == "Resource" || nameAttr.Value.StartsWith("Resource+"))) {
+                type.Remove();
+              }
+            }
+          }
+          if (xdoc.Root.Name == "Framework") {
+            foreach (var type in xdoc.Root.Descendants("Type").ToArray()) {
+              var nameAttr = type.Attribute("Name");
+              if (nameAttr != null && (nameAttr.Value == "Xamarin.Essentials.Resource" || nameAttr.Value.StartsWith("Xamarin.Essentials.Resource/"))) {
+                type.Remove();
+              }
+            }
+          }
+
           var settings = new XmlWriterSettings {
               Encoding = new UTF8Encoding(),
               Indent = true,
@@ -162,17 +189,25 @@
     <Task>
       <Reference Include="System.Xml" />
       <Reference Include="System.Xml.Linq" />
+      <Using Namespace="System.IO" />
       <Using Namespace="System.Xml" />
       <Using Namespace="System.Xml.Linq" />
       <Code Type="Fragment" Language="cs"><![CDATA[
         foreach (var file in Directory.EnumerateFiles(DocsRoot, "*.xml", SearchOption.AllDirectories)) {
           var xdoc = XDocument.Load(file);
-          var incomplete = xdoc.Descendants("Member").Where(x => x.Descendants().Any(d => d.Value == "To be added."));
+          var incomplete = xdoc.Descendants("Docs").Where(x => x.Descendants().Any(d => d.Value == "To be added."));
           foreach (var node in incomplete) {
-            var typename = xdoc.Root.Attribute("FullName").Value;
-            var member = node.Attribute("MemberName").Value;
-            var memberType = node.Element("MemberType").Value.ToLower();
-            Log.LogWarning("Missing docs for {2} '{0}.{1}'.", typename, member, memberType);
+            if (node.Parent.Name == "Type" && xdoc.Root.Name == "Type") {
+              var typename = xdoc.Root.Attribute("FullName").Value;
+              Log.LogWarning("Missing docs for {0}.", typename);
+            } else if (node.Parent.Name == "Member" && xdoc.Root.Name == "Type") {
+              var typename = xdoc.Root.Attribute("FullName").Value;
+              var member = node.Parent.Attribute("MemberName").Value;
+              var memberType = node.Parent.Element("MemberType").Value.ToLower();
+              Log.LogWarning("Missing docs for {2} '{0}.{1}'.", typename, member, memberType);
+            } else {
+              Log.LogWarning("Missing docs in {0}.", file);
+            }
           }
         }
       ]]></Code>

diff --git a/docs/en/FrameworksIndex/xamarin-essentials-android.xml b/docs/en/FrameworksIndex/xamarin-essentials-android.xml
@@ -15,6 +15,7 @@
       <Member Id="M:Xamarin.Essentials.AccelerometerData.GetHashCode" />
       <Member Id="M:Xamarin.Essentials.AccelerometerData.op_Equality(Xamarin.Essentials.AccelerometerData,Xamarin.Essentials.AccelerometerData)" />
       <Member Id="M:Xamarin.Essentials.AccelerometerData.op_Inequality(Xamarin.Essentials.AccelerometerData,Xamarin.Essentials.AccelerometerData)" />
+      <Member Id="M:Xamarin.Essentials.AccelerometerData.ToString" />
       <Member Id="P:Xamarin.Essentials.AccelerometerData.Acceleration" />
     </Type>
     <Type Name="Xamarin.Essentials.AppInfo" Id="T:Xamarin.Essentials.AppInfo">
@@ -40,6 +41,7 @@
       <Member Id="M:Xamarin.Essentials.BarometerData.GetHashCode" />
       <Member Id="M:Xamarin.Essentials.BarometerData.op_Equality(Xamarin.Essentials.BarometerData,Xamarin.Essentials.BarometerData)" />
       <Member Id="M:Xamarin.Essentials.BarometerData.op_Inequality(Xamarin.Essentials.BarometerData,Xamarin.Essentials.BarometerData)" />
+      <Member Id="M:Xamarin.Essentials.BarometerData.ToString" />
       <Member Id="P:Xamarin.Essentials.BarometerData.Pressure" />
     </Type>
     <Type Name="Xamarin.Essentials.Battery" Id="T:Xamarin.Essentials.Battery">
@@ -49,6 +51,7 @@
       <Member Id="P:Xamarin.Essentials.Battery.State" />
     </Type>
     <Type Name="Xamarin.Essentials.BatteryChangedEventArgs" Id="T:Xamarin.Essentials.BatteryChangedEventArgs">
+      <Member Id="M:Xamarin.Essentials.BatteryChangedEventArgs.ToString" />
       <Member Id="P:Xamarin.Essentials.BatteryChangedEventArgs.ChargeLevel" />
       <Member Id="P:Xamarin.Essentials.BatteryChangedEventArgs.PowerSource" />
       <Member Id="P:Xamarin.Essentials.BatteryChangedEventArgs.State" />
@@ -99,6 +102,7 @@
       <Member Id="M:Xamarin.Essentials.CompassData.GetHashCode" />
       <Member Id="M:Xamarin.Essentials.CompassData.op_Equality(Xamarin.Essentials.CompassData,Xamarin.Essentials.CompassData)" />
       <Member Id="M:Xamarin.Essentials.CompassData.op_Inequality(Xamarin.Essentials.CompassData,Xamarin.Essentials.CompassData)" />
+      <Member Id="M:Xamarin.Essentials.CompassData.ToString" />
       <Member Id="P:Xamarin.Essentials.CompassData.HeadingMagneticNorth" />
     </Type>
     <Type Name="Xamarin.Essentials.ConnectionProfile" Id="T:Xamarin.Essentials.ConnectionProfile">
@@ -115,6 +119,7 @@
       <Member Id="P:Xamarin.Essentials.Connectivity.Profiles" />
     </Type>
     <Type Name="Xamarin.Essentials.ConnectivityChangedEventArgs" Id="T:Xamarin.Essentials.ConnectivityChangedEventArgs">
+      <Member Id="M:Xamarin.Essentials.ConnectivityChangedEventArgs.ToString" />
       <Member Id="P:Xamarin.Essentials.ConnectivityChangedEventArgs.NetworkAccess" />
       <Member Id="P:Xamarin.Essentials.ConnectivityChangedEventArgs.Profiles" />
     </Type>
@@ -185,6 +190,11 @@
     <Type Name="Xamarin.Essentials.EnergySaverStatusChangedEventArgs" Id="T:Xamarin.Essentials.EnergySaverStatusChangedEventArgs">
       <Member Id="P:Xamarin.Essentials.EnergySaverStatusChangedEventArgs.EnergySaverStatus" />
     </Type>
+    <Type Name="Xamarin.Essentials.FeatureNotEnabledException" Id="T:Xamarin.Essentials.FeatureNotEnabledException">
+      <Member Id="M:Xamarin.Essentials.FeatureNotEnabledException.#ctor" />
+      <Member Id="M:Xamarin.Essentials.FeatureNotEnabledException.#ctor(System.String)" />
+      <Member Id="M:Xamarin.Essentials.FeatureNotEnabledException.#ctor(System.String,System.Exception)" />
+    </Type>
     <Type Name="Xamarin.Essentials.FeatureNotSupportedException" Id="T:Xamarin.Essentials.FeatureNotSupportedException">
       <Member Id="M:Xamarin.Essentials.FeatureNotSupportedException.#ctor" />
       <Member Id="M:Xamarin.Essentials.FeatureNotSupportedException.#ctor(System.String)" />
@@ -222,6 +232,7 @@
       <Member Id="M:Xamarin.Essentials.GeolocationRequest.#ctor" />
       <Member Id="M:Xamarin.Essentials.GeolocationRequest.#ctor(Xamarin.Essentials.GeolocationAccuracy)" />
       <Member Id="M:Xamarin.Essentials.GeolocationRequest.#ctor(Xamarin.Essentials.GeolocationAccuracy,System.TimeSpan)" />
+      <Member Id="M:Xamarin.Essentials.GeolocationRequest.ToString" />
       <Member Id="P:Xamarin.Essentials.GeolocationRequest.DesiredAccuracy" />
       <Member Id="P:Xamarin.Essentials.GeolocationRequest.Timeout" />
     </Type>
@@ -240,6 +251,7 @@
       <Member Id="M:Xamarin.Essentials.GyroscopeData.GetHashCode" />
       <Member Id="M:Xamarin.Essentials.GyroscopeData.op_Equality(Xamarin.Essentials.GyroscopeData,Xamarin.Essentials.GyroscopeData)" />
       <Member Id="M:Xamarin.Essentials.GyroscopeData.op_Inequality(Xamarin.Essentials.GyroscopeData,Xamarin.Essentials.GyroscopeData)" />
+      <Member Id="M:Xamarin.Essentials.GyroscopeData.ToString" />
       <Member Id="P:Xamarin.Essentials.GyroscopeData.AngularVelocity" />
     </Type>
     <Type Name="Xamarin.Essentials.Launcher" Id="T:Xamarin.Essentials.Launcher">
@@ -265,6 +277,7 @@
       <Member Id="M:Xamarin.Essentials.Location.CalculateDistance(Xamarin.Essentials.Location,Xamarin.Essentials.Location,Xamarin.Essentials.DistanceUnits)" />
       <Member Id="M:Xamarin.Essentials.Location.KilometersToMiles(System.Double)" />
       <Member Id="M:Xamarin.Essentials.Location.MilesToKilometers(System.Double)" />
+      <Member Id="M:Xamarin.Essentials.Location.ToString" />
       <Member Id="P:Xamarin.Essentials.Location.Accuracy" />
       <Member Id="P:Xamarin.Essentials.Location.Altitude" />
       <Member Id="P:Xamarin.Essentials.Location.Course" />
@@ -294,17 +307,18 @@
       <Member Id="M:Xamarin.Essentials.MagnetometerData.GetHashCode" />
       <Member Id="M:Xamarin.Essentials.MagnetometerData.op_Equality(Xamarin.Essentials.MagnetometerData,Xamarin.Essentials.MagnetometerData)" />
       <Member Id="M:Xamarin.Essentials.MagnetometerData.op_Inequality(Xamarin.Essentials.MagnetometerData,Xamarin.Essentials.MagnetometerData)" />
+      <Member Id="M:Xamarin.Essentials.MagnetometerData.ToString" />
       <Member Id="P:Xamarin.Essentials.MagnetometerData.MagneticField" />
     </Type>
     <Type Name="Xamarin.Essentials.MainThread" Id="T:Xamarin.Essentials.MainThread">
       <Member Id="M:Xamarin.Essentials.MainThread.BeginInvokeOnMainThread(System.Action)" />
       <Member Id="P:Xamarin.Essentials.MainThread.IsMainThread" />
     </Type>
     <Type Name="Xamarin.Essentials.MapDirectionsMode" Id="T:Xamarin.Essentials.MapDirectionsMode">
-      <Member Id="F:Xamarin.Essentials.MapDirectionsMode.None" />
       <Member Id="F:Xamarin.Essentials.MapDirectionsMode.Bicycling" />
       <Member Id="F:Xamarin.Essentials.MapDirectionsMode.Default" />
       <Member Id="F:Xamarin.Essentials.MapDirectionsMode.Driving" />
+      <Member Id="F:Xamarin.Essentials.MapDirectionsMode.None" />
       <Member Id="F:Xamarin.Essentials.MapDirectionsMode.Transit" />
       <Member Id="F:Xamarin.Essentials.MapDirectionsMode.Walking" />
     </Type>
@@ -346,6 +360,7 @@
       <Member Id="M:Xamarin.Essentials.OrientationSensorData.GetHashCode" />
       <Member Id="M:Xamarin.Essentials.OrientationSensorData.op_Equality(Xamarin.Essentials.OrientationSensorData,Xamarin.Essentials.OrientationSensorData)" />
       <Member Id="M:Xamarin.Essentials.OrientationSensorData.op_Inequality(Xamarin.Essentials.OrientationSensorData,Xamarin.Essentials.OrientationSensorData)" />
+      <Member Id="M:Xamarin.Essentials.OrientationSensorData.ToString" />
       <Member Id="P:Xamarin.Essentials.OrientationSensorData.Orientation" />
     </Type>
     <Type Name="Xamarin.Essentials.PermissionException" Id="T:Xamarin.Essentials.PermissionException">
@@ -357,6 +372,7 @@
     <Type Name="Xamarin.Essentials.Placemark" Id="T:Xamarin.Essentials.Placemark">
       <Member Id="M:Xamarin.Essentials.Placemark.#ctor" />
       <Member Id="M:Xamarin.Essentials.Placemark.#ctor(Xamarin.Essentials.Placemark)" />
+      <Member Id="M:Xamarin.Essentials.Placemark.ToString" />
       <Member Id="P:Xamarin.Essentials.Placemark.AdminArea" />
       <Member Id="P:Xamarin.Essentials.Placemark.CountryCode" />
       <Member Id="P:Xamarin.Essentials.Placemark.CountryName" />
@@ -429,6 +445,7 @@
       <Member Id="M:Xamarin.Essentials.ScreenMetrics.GetHashCode" />
       <Member Id="M:Xamarin.Essentials.ScreenMetrics.op_Equality(Xamarin.Essentials.ScreenMetrics,Xamarin.Essentials.ScreenMetrics)" />
       <Member Id="M:Xamarin.Essentials.ScreenMetrics.op_Inequality(Xamarin.Essentials.ScreenMetrics,Xamarin.Essentials.ScreenMetrics)" />
+      <Member Id="M:Xamarin.Essentials.ScreenMetrics.ToString" />
       <Member Id="P:Xamarin.Essentials.ScreenMetrics.Density" />
       <Member Id="P:Xamarin.Essentials.ScreenMetrics.Height" />
       <Member Id="P:Xamarin.Essentials.ScreenMetrics.Orientation" />