This repository has been archived by the owner on May 29, 2024. It is now read-only.
Import documentation for API-30. #23
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Docs Build status updates of commit 0052d2e: ❌ Validation status: errorsPlease follow instructions here which may help to resolve issue. This comment lists only the first 50 files in the pull request.
docs/Mono.Android/en/Android.AccessibilityServices/AccessibilityGesture.xml
docs/Mono.Android/en/Android.AccessibilityServices/AccessibilityServiceCapabilities.xml
docs/Mono.Android/en/Android.AccessibilityServices/AccessibilityServiceFlags.xml
docs/Mono.Android/en/Android.AccessibilityServices/AccessibilityServiceShowMode.xml
docs/Mono.Android/en/Android.AccessibilityServices/GlobalAction.xml
docs/Mono.Android/en/Android.App.Admin/KeyguardDisable.xml
docs/Mono.Android/en/Android.App.Admin/SecurityLogTags.xml
docs/Mono.Android/en/Android.App.Admin/UserManagementFlags.xml
docs/Mono.Android/en/Android.App.Admin/WipeDataFlags.xml
docs/Mono.Android/en/Android.App.Assist/AssistTextStyle.xml
docs/Mono.Android/en/Android.App.Job/NetworkType.xml
docs/Mono.Android/en/Android.App.Job/TriggerContentUriFlags.xml
docs/Mono.Android/en/Android.App.Usage/MeteredStates.xml
docs/Mono.Android/en/Android.App.Usage/NetworkUsageRoaming.xml
docs/Mono.Android/en/Android.App.Usage/NetworkUsageState.xml
docs/Mono.Android/en/Android.App.Usage/UsageEventType.xml
docs/Mono.Android/en/Android.App.Usage/UsageStatsInterval.xml
docs/Mono.Android/en/Android.App/AppOpsManagerMode.xml
docs/Mono.Android/en/Android.App/DownloadNetwork.xml
docs/Mono.Android/en/Android.App/DownloadVisibility.xml
docs/Mono.Android/en/Android.App/Importance.xml
docs/Mono.Android/en/Android.App/NotificationFlags.xml
docs/Mono.Android/en/Android.App/NotificationPriorityCategory.xml
docs/Mono.Android/en/Android.App/NotificationPrioritySenders.xml
docs/Mono.Android/en/Android.App/SuppressedEffects.xml
docs/Mono.Android/en/Android.App/UiNightMode.xml
docs/Mono.Android/en/Android.App/WearableSizePreset.xml
docs/Mono.Android/en/Android.Bluetooth/DeviceClass.xml
docs/Mono.Android/en/Android.Bluetooth/ProfileType.xml
docs/Mono.Android/en/Android.Content.PM/ActivityInfoFlags.xml
docs/Mono.Android/en/Android.Content.PM/ComponentEnableOption.xml
docs/Mono.Android/en/Android.Content.PM/LauncherAppsShortcutQueryFlags.xml
docs/Mono.Android/en/Android.Content.PM/PackageInfoFlags.xml
docs/Mono.Android/en/Android.Content.PM/PackageInstallMode.xml
docs/Mono.Android/en/Android.Content.PM/PermissionInfoFlags.xml
docs/Mono.Android/en/Android.Content.PM/PinItemRequestType.xml
docs/Mono.Android/en/Android.Content.PM/ServiceInfoFlags.xml
docs/Mono.Android/en/Android.Content/ActivityFlags.xml
docs/Mono.Android/en/Android.Content/Bind.xml
docs/Mono.Android/en/Android.Content/FillInFlags.xml
docs/Mono.Android/en/Android.Content/NotifyChangeFlags.xml
docs/Mono.Android/en/Android.Drm/DrmStoreActionCode.xml
docs/Mono.Android/en/Android.Drm/DrmStorePlaybackCode.xml
docs/Mono.Android/en/Android.Drm/DrmStoreRightsStatusCode.xml
docs/Mono.Android/en/Android.Graphics.Pdf/PdfRenderMode.xml
docs/Mono.Android/en/Android.Graphics/ImageFormatType.xml
docs/Mono.Android/en/Android.Hardware.Camera2/CameraError.xml
docs/Mono.Android/en/Android.Hardware.Camera2/ControlAEMode.xml
docs/Mono.Android/en/Android.Hardware.Camera2/ControlCaptureIntent.xml
For more details, please refer to the build report. If you see build warnings/errors with permission issues, it might be due to single sign-on (SSO) enabled on Microsoft's GitHub organizations. Please follow instructions here to re-authorize your GitHub account to Docs Build. Note: Broken links written as relative paths are included in the above build report. For broken links written as absolute paths or external URLs, see the broken link report. Note: Your PR may contain errors or warnings unrelated to the files you changed. This happens when external dependencies like GitHub alias, Microsoft alias, cross repo links are updated. Please use these instructions to resolve them. For any questions, please:
|
jonpryor
added a commit
to jonpryor/xamarin-android
that referenced
this pull request
Jan 11, 2021
Fixes: dotnet#5200 Context: a7413a2 Context: xamarin/android-api-docs#23 Add a new `UpdateExternalDocumentation` target which: 1. *Rebuilds* `src/Mono.Android` with `$(IncludeAndroidJavadoc)`=True. This produces a `Mono.Anroid.xml` file containing imported API-30 Javadoc. 2. Run `mdoc update --import Mono.Android.xml`, updating the [**mdoc**(5) documentation][0] within `external/android-api-docs/docs/Mono.Android/en` Usage: msbuild /t:UpdateExternalDocumentation src/Mono.Android/Mono.Android.csproj This process takes ~65 minutes on my machine. Note: This uses the [mdoc NuGet package][1]. [0]: http://docs.go-mono.com/?link=man%3amdoc(5) [1]: https://www.nuget.org/packages/mdoc/
Context: dotnet/android#5485 Context: dotnet/android@a7413a2 Update the `Mono.Android.dll` documentation, importing the Google-provided [API-30 Javadoc documentation][0]. At this time, only the following documentation is imported: * `<exception/>`: The Javadoc `@throws` block tag. * `<param/>`: The Javadoc `@param` block tag. * `<returns/>`: The Javadoc `@returns` block tag. * `<summary/>`: First sentence in Javadoc comment. Additionally, the following information is generated: * Documentation Copyright notification * HTML Link to the Android documentation for the member. Note that the link to Android documentation may not work; there are known issues around the use of generic types. (There are *lots* of issues here, e.g. `<see/>` will be emitted which references the Java type names, not the managed type names, and thus is invalid.) The perfect is the enemy of the good (enough)! It's been 4+ years since the last documentation import. Let's get *something* newer. [0]: http://dl.google.com/android/repository/sources-30_r01.zip
0052d2e to
e048ed3
Compare
|
Docs Build status updates of commit e048ed3:
|
jonpryor
added a commit
to jonpryor/xamarin-android
that referenced
this pull request
Jan 12, 2021
Fixes: dotnet#5200 Context: a7413a2 Context: xamarin/android-api-docs#23 Context: https://review.docs.microsoft.com/en-us/engineering/projects/reference/dotnet/mdoc Add a new `UpdateExternalDocumentation` target which: 1. *Rebuilds* `src/Mono.Android` with `$(IncludeAndroidJavadoc)`=True. This produces a `Mono.Anroid.xml` file containing imported API-30 Javadoc. This *also* produces the log file `src/Mono.Android/UpdateExternalDocumentation-{TIME}.binlog`, which contains the build output for the rebuild. 2. Runs `mdoc update --import Mono.Android.xml --use-docid`, updating the [**mdoc**(5) documentation][0] within `external/android-api-docs/docs/Mono.Android/en` The `--use-docid` flag is needed for integration with the documentation infrastructure. Usage: msbuild /t:UpdateExternalDocumentation src/Mono.Android/Mono.Android.csproj This process takes ~60 minutes on my machine. Note: This uses the [mdoc NuGet package][1]. [0]: http://docs.go-mono.com/?link=man%3amdoc(5) [1]: https://www.nuget.org/packages/mdoc/
jonpryor
added a commit
to jonpryor/xamarin-android
that referenced
this pull request
Jan 13, 2021
Fixes: dotnet#5200 Context: a7413a2 Context: xamarin/android-api-docs#23 Context: https://review.docs.microsoft.com/en-us/engineering/projects/reference/dotnet/mdoc Add a new `UpdateExternalDocumentation` target which: 1. *Rebuilds* `src/Mono.Android` with `$(IncludeAndroidJavadoc)`=True. This produces a `Mono.Anroid.xml` file containing imported API-30 Javadoc. This *also* produces the log file `src/Mono.Android/UpdateExternalDocumentation-{TIME}.binlog`, which contains the build output for the rebuild. 2. Runs `mdoc update --import Mono.Android.xml --use-docid`, updating the [**mdoc**(5) documentation][0] within `external/android-api-docs/docs/Mono.Android/en` The `--use-docid` flag is needed for integration with the documentation infrastructure. Usage: msbuild /t:UpdateExternalDocumentation src/Mono.Android/Mono.Android.csproj This process takes ~60 minutes on my machine. Note: This uses the [mdoc NuGet package][1]. [0]: http://docs.go-mono.com/?link=man%3amdoc(5) [1]: https://www.nuget.org/packages/mdoc/
jonpryor
added a commit
to jonpryor/xamarin-android
that referenced
this pull request
Jan 14, 2021
Fixes: dotnet#5200 Context: a7413a2 Context: xamarin/android-api-docs#23 Context: https://review.docs.microsoft.com/en-us/engineering/projects/reference/dotnet/mdoc Add a new `UpdateExternalDocumentation` target which: 1. *Rebuilds* `src/Mono.Android` with `$(IncludeAndroidJavadoc)`=True. This produces a `Mono.Anroid.xml` file containing imported API-30 Javadoc. This *also* produces the log file `src/Mono.Android/UpdateExternalDocumentation-{TIME}.binlog`, which contains the build output for the rebuild. 2. Runs `mdoc update --import Mono.Android.xml --use-docid`, updating the [**mdoc**(5) documentation][0] within `external/android-api-docs/docs/Mono.Android/en` The `--use-docid` flag is needed for integration with the documentation infrastructure. Usage: msbuild /t:UpdateExternalDocumentation src/Mono.Android/Mono.Android.csproj This process takes ~60 minutes on my machine. Note: This uses the [mdoc NuGet package][1]. [0]: http://docs.go-mono.com/?link=man%3amdoc(5) [1]: https://www.nuget.org/packages/mdoc/
|
Docs Build status updates of commit e73018e:
|
|
Docs Build status updates of commit e8b30e7:
|
This reverts commit e8b30e7.
|
Docs Build status updates of commit f8e40ff:
|
pjcollins
added a commit
to pjcollins/java.interop
that referenced
this pull request
May 19, 2021
Context: dotnet#843 Context: xamarin/android-api-docs#23 A handful of "broken" Javadoc to C# Doc conversions have been disabled for now. This will hopefully help reduce the number of new warnings introduced by xamarin/android-api-docs#23, and allow us to get an initial major documentation update landed in the short term. Longer term, we will revisit and fix these Javadoc conversion issues. Additionally, `Javadoc.cs` has been removed from tools/generator as it appeared to be an unused partial duplicate of `JavadocInfo.cs`.
pjcollins
added a commit
to pjcollins/java.interop
that referenced
this pull request
May 19, 2021
Context: dotnet#843 Context: xamarin/android-api-docs#23 A handful of "broken" Javadoc to C# Doc conversions have been disabled for now. This will hopefully help reduce the number of new warnings introduced by xamarin/android-api-docs#23, and allow us to get an initial major documentation update landed in the short term. Longer term, we will revisit and fix these Javadoc conversion issues. Additionally, `Javadoc.cs` has been removed from tools/generator as it appeared to be an unused partial duplicate of `JavadocInfo.cs`.
jonpryor
added a commit
to dotnet/android
that referenced
this pull request
Sep 29, 2021
Context: a7413a2 Context: #5200 Context: xamarin/android-api-docs#23 Context: https://review.docs.microsoft.com/en-us/engineering/projects/reference/dotnet/mdoc Add a new `UpdateExternalDocumentation` target to `src/Mono.Android/Mono.Android.csproj` which: 1. *Rebuilds* `src/Mono.Android` with `$(IncludeAndroidJavadoc)`=True. This produces a `Mono.Anroid.xml` file containing imported API-30 Javadoc. On macOS, this *also* produces the log file `src/Mono.Android/UpdateExternalDocumentation-{TIME}.binlog`, which contains the build output for the rebuild. 2. Runs `mdoc update --import Mono.Android.xml --use-docid`, updating the [**mdoc**(5) documentation][0] within `external/android-api-docs/docs/Mono.Android/en` The `--use-docid` flag is needed for integration with the documentation infrastructure. Usage: msbuild /t:UpdateExternalDocumentation src/Mono.Android/Mono.Android.csproj This process takes ~60 minutes on my machine. Additionally, add a new `RunMdoc` target, which just runs the `mdoc update --import…` command. This is useful for one-off testing. The `UpdateExternalDocumentation` and `RunMdoc` targets also takes an optional `$(DocTypeName)` MSBuild property, which is used to restrict the types that `mdoc update` will update: msbuild /p:DocTypeName=Java.Lang.Object /t:UpdateExternalDocumentation src/Mono.Android/Mono.Android.csproj # -or- msbuild /p:DocTypeName=Java.Lang.Object /t:RunMdoc src/Mono.Android/Mono.Android.csproj Note: This uses the [mdoc NuGet package][1]. [0]: http://docs.go-mono.com/?link=man%3amdoc(5) [1]: https://www.nuget.org/packages/mdoc/5.8.0
pjcollins
added a commit
to pjcollins/java.interop
that referenced
this pull request
Oct 27, 2021
Context: dotnet#843 Context: xamarin/android-api-docs#23 A handful of "broken" Javadoc to C# Doc conversions have been disabled for now. This will hopefully help reduce the number of new warnings introduced by xamarin/android-api-docs#23, and allow us to get an initial major documentation update landed in the short term. Longer term, we will revisit and fix these Javadoc conversion issues. Additionally, `Javadoc.cs` has been removed from tools/generator as it appeared to be an unused partial duplicate of `JavadocInfo.cs`. Finally, the `<tt>` tag is no longer supported in our docs build: HTML tag 'tt' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. It has been replaced with `<code>` when generating Android Doc links.
jonpryor
pushed a commit
to dotnet/java-interop
that referenced
this pull request
Nov 8, 2021
) Context: #843 Context: xamarin/android-api-docs#23 A handful of "broken" Javadoc to C# Doc conversions have been disabled for now. This will hopefully help reduce the number of new warnings introduced by xamarin/android-api-docs#23, and allow us to get an initial major documentation update landed in the short term. Longer term, we will revisit and fix these Javadoc conversion issues. Additionally, `Javadoc.cs` has been removed from tools/generator as it appeared to be an unused partial duplicate of `JavadocInfo.cs`. Finally, the `<tt>` tag is no longer supported in our docs build: HTML tag 'tt' isn't allowed. Replace it with approved Markdown or escape the brackets if the content is a placeholder. It has been replaced with `<code>` when generating Android Doc links.
|
Superseded by #26. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context: dotnet/android#5485
Context: dotnet/android@a7413a2
Update the
Mono.Android.dlldocumentation, importing theGoogle-provided API-30 Javadoc documentation.
At this time, only the following documentation is imported:
<exception/>: The Javadoc@throwsblock tag.<param/>: The Javadoc@paramblock tag.<returns/>: The Javadoc@returnsblock tag.<summary/>: First sentence in Javadoc comment.Additionally, the following information is generated:
Note that the link to Android documentation may not work; there are
known issues around the use of generic types. (There are lots
of issues here, e.g.
<see/>will be emitted which references theJava type names, not the managed type names, and thus is invalid.)
The perfect is the enemy of the good (enough)! It's been 4+ years
since the last documentation import. Let's get something newer.