Skip to content

[Mono.Android] Move Android documentation notices - #12220

Merged
jonathanpeppers merged 4 commits into
mainfrom
jonathanpeppers-fix-intellisense-legal-notice
Jul 24, 2026
Merged

[Mono.Android] Move Android documentation notices#12220
jonathanpeppers merged 4 commits into
mainfrom
jonathanpeppers-fix-intellisense-legal-notice

Conversation

@jonathanpeppers

Copy link
Copy Markdown
Member

Pull Request
title and
description
should follow the
commit-messages.md workflow documentation, and in particular should include:

Android documentation attribution is currently appended to every generated XML documentation member. This exposes a legal disclaimer throughout IntelliSense and obscures useful API documentation.

Stop injecting the production copyright file into generated member documentation while retaining CopyrightFile support for binding projects. Move the Android documentation attribution and applicable Apache 2.0, GPLv2 with Classpath Exception, ICU, and W3C license texts into the third-party notices shipped with the product.

  • Useful description of why the change is necessary.
  • Links to issues fixed
  • Unit tests

The focused JavaSourceJar tests pass for CoreCLR and NativeAOT.

Fixes #3788

Android documentation attribution was appended to every generated XML
documentation member.  This exposed a legal disclaimer throughout
IntelliSense and obscured useful API documentation.

Stop passing the production copyright file to java-source-utils.  Retain
CopyrightFile support for binding projects with a dedicated test fixture,
and place the Android documentation attribution and license texts in the
third-party notices shipped with the product.

Fixes #3788

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>
Copilot-Session: ce04439e-2ebe-4633-986f-65bf47a22f05
Copilot AI review requested due to automatic review settings July 23, 2026 21:28

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR addresses #3788 by removing the Android documentation attribution/legal notice that was being injected into every generated XML documentation member (and thus exposed in IntelliSense), and instead relocating the attribution and associated license texts into the product’s third-party notices while keeping CopyrightFile support for binding projects.

Changes:

  • Add an “Android API documentation” entry to THIRD-PARTY-NOTICES.TXT and include the required attribution + Apache 2.0 / GPLv2+Classpath / ICU / W3C license texts.
  • Stop passing --doc-copyright (and the Mono.Android javadoc-copyright.xml) when generating Mono.Android’s javadoc-derived XML.
  • Update tests to use a local test javadoc-copyright.xml resource to continue validating CopyrightFile import behavior for bindings.

Reviewed changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
THIRD-PARTY-NOTICES.TXT Adds a dedicated Android API documentation notice section and embeds the relevant license texts.
src/Xamarin.Android.Build.Tasks/Tests/Xamarin.Android.Build.Tests/Xamarin.Android.Build.Tests.csproj Removes embedding the Mono.Android copyright XML into the test assembly.
src/Xamarin.Android.Build.Tasks/Tests/Xamarin.Android.Build.Tests/Resources/javadoc-copyright.xml Adds a test-only copyright XML snippet used by CopyrightFile tests.
src/Xamarin.Android.Build.Tasks/Tests/Xamarin.Android.Build.Tests/BindingBuildTest.cs Updates the JavaSourceJar test to validate the new test notice content is imported.
src/Mono.Android/Mono.Android.targets Removes default --doc-copyright arguments so generated docs no longer include the notice everywhere.
src/Mono.Android/javadoc-copyright.xml Removes the previously injected Android Open Source Project attribution snippet.

Comment thread THIRD-PARTY-NOTICES.TXT Outdated
Use the canonical FSF wording for GPLv2 section 3(c) instead of the typo present in Android's hosted copy.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: ce04439e-2ebe-4633-986f-65bf47a22f05
Keep the existing trailing blank line unchanged after correcting the GPLv2 text.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: ce04439e-2ebe-4633-986f-65bf47a22f05
Avoid changing the existing trailing spacing in the third-party notices file.

Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: ce04439e-2ebe-4633-986f-65bf47a22f05
@jonathanpeppers
jonathanpeppers enabled auto-merge (squash) July 24, 2026 13:22
@jonathanpeppers jonathanpeppers added the ready-to-review This PR is ready to review/merge, I think any CI failures are just flaky (ignorable). label Jul 24, 2026
@jonathanpeppers
jonathanpeppers merged commit aab6791 into main Jul 24, 2026
44 checks passed
@jonathanpeppers
jonathanpeppers deleted the jonathanpeppers-fix-intellisense-legal-notice branch July 24, 2026 14:12
@github-actions github-actions Bot locked and limited conversation to collaborators Aug 24, 2026
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

ready-to-review This PR is ready to review/merge, I think any CI failures are just flaky (ignorable).

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Enhancement] Remove legal fluff from IntelliSense

3 participants