Bug 1458668 - Link CHANGELOG.md in javadoc. r=snorp,geckoview-reviewers
authorAgi Sferro <agi@mozilla.com>
Wed, 19 Dec 2018 15:48:17 +0000
changeset 511337 30abf82080a3b3f4e5d2bc9d6868b9a7cbbb7954
parent 511336 cc290b5855ebbf80801a08f2d57ebefed1d7eeb7
child 511338 fa90df2db90a81a4e0d8820d36f3608a84e97565
push id1953
push userffxbld-merge
push dateMon, 11 Mar 2019 12:10:20 +0000
treeherdermozilla-release@9c35dcbaa899 [default view] [failures only]
perfherder[talos] [build metrics] [platform microbench] (compared to previous push)
reviewerssnorp, geckoview-reviewers
bugs1458668
milestone66.0a1
first release with
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
last release without
nightly linux32
nightly linux64
nightly mac
nightly win32
nightly win64
Bug 1458668 - Link CHANGELOG.md in javadoc. r=snorp,geckoview-reviewers This moves the CHANGELOG.md file to a /doc-files folder that gets picked up by javadoc. Our javadoc files are hosted on a github.io page which will render the markdown file with the geckoview profile. Depends on D13883 Differential Revision: https://phabricator.services.mozilla.com/D14786
mobile/android/geckoview/CHANGELOG.md
mobile/android/geckoview/build.gradle
mobile/android/geckoview/src/main/java/org/mozilla/geckoview/doc-files/CHANGELOG.md
mobile/android/geckoview/src/main/java/org/mozilla/geckoview/package-info.java
--- a/mobile/android/geckoview/build.gradle
+++ b/mobile/android/geckoview/build.gradle
@@ -491,11 +491,11 @@ if (mozconfig.substs.MOZ_JAVA_CODE_COVER
     }
 }
 
 apply plugin: 'org.mozilla.apilint'
 
 apiLint {
     // TODO: Change this to `org` after hiding org.mozilla.gecko
     packageFilter = 'org.mozilla.geckoview'
-    changelogFileName = 'CHANGELOG.md'
+    changelogFileName = 'src/main/java/org/mozilla/geckoview/doc-files/CHANGELOG.md'
     lintFilters = ['GV']
 }
rename from mobile/android/geckoview/CHANGELOG.md
rename to mobile/android/geckoview/src/main/java/org/mozilla/geckoview/doc-files/CHANGELOG.md
--- a/mobile/android/geckoview/CHANGELOG.md
+++ b/mobile/android/geckoview/src/main/java/org/mozilla/geckoview/doc-files/CHANGELOG.md
@@ -1,9 +1,15 @@
-# v65
+---
+layout: geckoview
+---
+
+<h1> GeckoView API Changelog. </h1>
+
+## v65
 - Moved `CompositorController`, `DynamicToolbarAnimator`,
   `OverscrollEdgeEffect`, `PanZoomController` from `org.mozilla.gecko.gfx` to
   `org.mozilla.geckoview`
 - Added `@UiThread`, `@AnyThread` annotations to all APIs
 - Changed `GeckoRuntime#getLocale` to `GeckoRuntime#getLocales` and related APIs.
 - Merged `org.mozilla.gecko.gfx.LayerSession` into `GeckoSession`
 - Added `GeckoSession.MediaDelegate` and `MediaElement`. This allow monitoring
   and control of web media elements (play, pause, seek, etc).
--- a/mobile/android/geckoview/src/main/java/org/mozilla/geckoview/package-info.java
+++ b/mobile/android/geckoview/src/main/java/org/mozilla/geckoview/package-info.java
@@ -38,10 +38,11 @@
  *     <li>{@link android.Manifest.permission#ACCESS_COARSE_LOCATION}</li>
  *     <li>{@link android.Manifest.permission#ACCESS_FINE_LOCATION}</li>
  *     <li>{@link android.Manifest.permission#READ_EXTERNAL_STORAGE}</li>
  *     <li>{@link android.Manifest.permission#WRITE_EXTERNAL_STORAGE}</li>
  *     <li>{@link android.Manifest.permission#CAMERA}</li>
  *     <li>{@link android.Manifest.permission#RECORD_AUDIO}</li>
  * </ul>
  *
+ * For a detailed change log of the API see: <a href="./doc-files/CHANGELOG">CHANGELOG</a>.
  */
 package org.mozilla.geckoview;