Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 003f49cf authored by Nan Zhang's avatar Nan Zhang Committed by Gerrit Code Review
Browse files

Merge changes from topic "offlinesdk-docs" 

* changes:
  Add more libs for framework docs generation
  Add offline/online-sdk-docs in Soong.
parents f8e12c51 dbc25314

Android.bp

+289 −11
Original line number Diff line number Diff line
@@ -826,7 +826,11 @@ packages_to_document = [ 
// Conscrypt (com.android.org.conscrypt) is an implementation detail and should

// not be referenced in the documentation.

framework_docs_args = "-android -manifest $(location core/res/AndroidManifest.xml) " +

     "-hidePackage com.android.okhttp -hidePackage com.android.org.conscrypt -hidePackage com.android.server " +

     "-hidePackage com.android.internal " +

     "-hidePackage com.android.internal.util " +

     "-hidePackage com.android.okhttp " +

     "-hidePackage com.android.org.conscrypt " +

     "-hidePackage com.android.server " +

     "-since $(location 1/public/api/android.xml) 1 " +

     "-since $(location 2/public/api/android.xml) 2 " +

     "-since $(location 3/public/api/android.xml) 3 " +
@@ -854,6 +858,8 @@ framework_docs_args = "-android -manifest $(location core/res/AndroidManifest.xm 
     "-since $(location 25/public/api/android.txt) 25 " +

     "-since $(location 26/public/api/android.txt) 26 " +

     "-since $(location 27/public/api/android.txt) 27 " +

     "-since $(location 28/public/api/android.txt) 28 " +

     "-since $(location api/current.txt) Q " +

     "-werror -lerror -hide 111 -hide 113 -hide 125 -hide 126 -hide 127 -hide 128 " +

     "-overview $(location core/java/overview.html) " +

     // Federate Support Library references against local API file.
@@ -861,7 +867,7 @@ framework_docs_args = "-android -manifest $(location core/res/AndroidManifest.xm 
     "-federationapi SupportLib $(location current/support-api.txt) "



doc_defaults {

    name: "framework-docs-default",

    name: "api-stubs-default",

    srcs: [

        // test mock src files.

        "test-mock/src/android/test/mock/**/*.java",
@@ -925,12 +931,13 @@ check_current_api_args = "-error 2 -error 3 -error 4 -error 5 -error 6 " + 


droiddoc {

    name: "api-stubs-docs",

    defaults: ["framework-docs-default"],

    defaults: ["api-stubs-default"],

    arg_files: [

        "core/res/AndroidManifest.xml",

        ":api-version-xml",

        "core/java/overview.html",

        ":current-support-api",

        "api/current.txt",

    ],

    api_filename: "public_api.txt",

    private_api_filename: "private.txt",
@@ -952,12 +959,13 @@ droiddoc { 


droiddoc {

    name: "system-api-stubs-docs",

    defaults: ["framework-docs-default"],

    defaults: ["api-stubs-default"],

    arg_files: [

        "core/res/AndroidManifest.xml",

        ":api-version-xml",

        "core/java/overview.html",

        ":current-support-api",

        "api/current.txt",

    ],

    api_tag_name: "SYSTEM",

    api_filename: "system-api.txt",
@@ -982,12 +990,13 @@ droiddoc { 


droiddoc {

    name: "test-api-stubs-docs",

    defaults: ["framework-docs-default"],

    defaults: ["api-stubs-default"],

    arg_files: [

        "core/res/AndroidManifest.xml",

        ":api-version-xml",

        "core/java/overview.html",

        ":current-support-api",

        "api/current.txt",

    ],

    api_tag_name: "TEST",

    api_filename: "test-api.txt",
@@ -1003,6 +1012,273 @@ droiddoc { 
    },

}



doc_defaults {

    name: "framework-docs-default",

    srcs: [

        "test-base/src/**/*.java",

        ":opt-telephony-srcs",

        ":opt-net-voip-srcs",

        ":openjdk_javadoc_files",

        ":non_openjdk_javadoc_files",

        ":android_icu4j_src_files_for_docs",

        ":gen-ojluni-jaif-annotated-srcs",

        ":frameworks-data-binding-srcs",

        "test-runner/src/**/*.java",

    ],

    exclude_srcs: [

        ":annotated_ojluni_files",

    ],

    srcs_lib: "framework",

    srcs_lib_whitelist_dirs: frameworks_base_subdirs,

    srcs_lib_whitelist_pkgs: packages_to_document,

    libs: [

        "conscrypt",

        "bouncycastle",

        "voip-common",

        "android.test.mock",

        "android-support-annotations",

        "android-support-compat",

        "android-support-core-ui",

        "android-support-core-utils",

        "android-support-customtabs",

        "android-support-design",

        "android-support-dynamic-animation",

        "android-support-exifinterface",

        "android-support-fragment",

        "android-support-media-compat",

        "android-support-percent",

        "android-support-recommendation",

        "android-support-transition",

        "android-support-tv-provider",

        "android-support-v7-cardview",

        "android-support-v7-gridlayout",

        "android-support-v7-mediarouter",

        "android-support-v7-palette",

        "android-support-v7-preference",

        "android-support-v13",

        "android-support-v14-preference",

        "android-support-v17-leanback",

        "android-support-v17-preference-leanback",

        "android-support-wear",

        "android-support-vectordrawable",

        "android-support-animatedvectordrawable",

        "android-support-v7-appcompat",

        "android-support-v7-recyclerview",

        "android-support-emoji",

        "android-support-emoji-appcompat",

        "android-support-emoji-bundled",

        "android-support-v8-renderscript",

        "android-support-multidex",

        "android-support-multidex-instrumentation",

    ],

    local_sourcepaths: frameworks_base_subdirs,

    html_dirs: [

        "docs/html",

    ],

    knowntags: [

        "docs/knowntags.txt",

        ":known-oj-tags",

    ],

    custom_template: "droiddoc-templates-sdk",

    resourcesdir: "docs/html/reference/images/",

    resourcesoutdir: "reference/android/images/",

    hdf: [

        "dac true",

        "sdk.codename O",

        "sdk.preview.version 1",

        "sdk.version 7.0",

        "sdk.rel.id 1",

        "sdk.preview 0",

    ],

    arg_files: [

        "core/res/AndroidManifest.xml",

        ":api-version-xml",

        "core/java/overview.html",

        ":current-support-api",

        "api/current.txt",

    ],

    create_stubs: false,

}



droiddoc {

    name: "doc-comment-check-docs",

    defaults: ["framework-docs-default"],

    args: framework_docs_args + " -referenceonly -parsecomments",

    installable: false,

}



droiddoc {

    name: "offline-sdk-docs",

    defaults: ["framework-docs-default"],

    hdf: [

        "android.whichdoc offline",

    ],

    proofread_file: "offline-sdk-docs-proofrerad.txt",

    args: framework_docs_args + " -offlinemode -title \"Android SDK\"",

    write_sdk_values: true,

    static_doc_index_redirect: "docs/docs-preview-index.html",

}



droiddoc {

    name: "offline-sdk-referenceonly-docs",

    defaults: ["framework-docs-default"],

    hdf: [

        "android.whichdoc offline",

    ],

    proofread_file: "offline-sdk-referenceonly-docs-proofrerad.txt",

    args: framework_docs_args + " -offlinemode -title \"Android SDK\" -referenceonly",

    write_sdk_values: true,

    static_doc_index_redirect: "docs/docs-documentation-redirect.html",

    static_doc_properties: "docs/source.properties",

}



droiddoc {

    name: "online-sdk-docs",

    defaults: ["framework-docs-default"],

    hdf: [

        "android.whichdoc online",

        "android.hasSamples true",

    ],

    proofread_file: "online-sdk-docs-proofrerad.txt",

    args: framework_docs_args +

        " -toroot / -samplegroup Admin " +

        " -samplegroup Background " +

        " -samplegroup Connectivity " +

        " -samplegroup Content " +

        " -samplegroup Input " +

        " -samplegroup Media " +

        " -samplegroup Notification " +

        " -samplegroup RenderScript " +

        " -samplegroup Security " +

        " -samplegroup Sensors " +

        " -samplegroup System " +

        " -samplegroup Testing " +

        " -samplegroup UI " +

        " -samplegroup Views " +

        " -samplegroup Wearable -samplesdir development/samples/browseable ",

}



droiddoc {

    name: "online-system-api-sdk-docs",

    defaults: ["framework-docs-default"],

    hdf: [

        "android.whichdoc online",

        "android.hasSamples true",

    ],

    proofread_file: "online-system-api-sdk-docs-proofrerad.txt",

    args: framework_docs_args +

        " -referenceonly " +

        " -showAnnotation android.annotation.SystemApi " +

        " -title \"Android SDK - Including system APIs.\" " +

        " -hide 101 " +

        " -hide 104 " +

        " -hide 108 " +

        " -toroot / -samplegroup Admin " +

        " -samplegroup Background " +

        " -samplegroup Connectivity " +

        " -samplegroup Content " +

        " -samplegroup Input " +

        " -samplegroup Media " +

        " -samplegroup Notification " +

        " -samplegroup RenderScript " +

        " -samplegroup Security " +

        " -samplegroup Sensors " +

        " -samplegroup System " +

        " -samplegroup Testing " +

        " -samplegroup UI " +

        " -samplegroup Views " +

        " -samplegroup Wearable -samplesdir development/samples/browseable ",

    installable: false,

}



droiddoc {

    name: "ds-docs",

    defaults: ["framework-docs-default"],

    hdf: [

        "android.whichdoc online",

        "android.hasSamples true",

    ],

    proofread_file: "ds-docs-proofrerad.txt",

    args: framework_docs_args +

        " -toroot / -samplegroup Admin " +

        " -samplegroup Background " +

        " -samplegroup Connectivity " +

        " -samplegroup Content " +

        " -samplegroup Input " +

        " -samplegroup Media " +

        " -samplegroup Notification " +

        " -samplegroup RenderScript " +

        " -samplegroup Security " +

        " -samplegroup Sensors " +

        " -samplegroup System " +

        " -samplegroup Testing " +

        " -samplegroup UI " +

        " -samplegroup Views " +

        " -samplegroup Wearable -devsite -samplesdir development/samples/browseable ",

}



droiddoc {

    name: "ds-static-docs",

    defaults: ["framework-docs-default"],

    hdf: [

        "android.whichdoc online",

    ],

    proofread_file: "ds-static-docs-proofrerad.txt",

    args: framework_docs_args +

          " -staticonly " +

          " -toroot / " +

          " -devsite " +

          " -ignoreJdLinks ",

}



droiddoc {

    name: "ds-ref-navtree-docs",

    defaults: ["framework-docs-default"],

    hdf: [

        "android.whichdoc online",

    ],

    proofread_file: "ds-ref-navtree-docs-proofrerad.txt",

    args: framework_docs_args +

          " -toroot / " +

          " -atLinksNavtree " +

          " -navtreeonly ",

}



droiddoc {

    name: "online-sdk-dev-docs",

    defaults: ["framework-docs-default"],

    hdf: [

        "android.whichdoc online",

        "android.hasSamples true",

    ],

    proofread_file: "online-sdk-dev-docs-proofrerad.txt",

    args: framework_docs_args +

        " -toroot / -samplegroup Admin " +

        " -samplegroup Background " +

        " -samplegroup Connectivity " +

        " -samplegroup Content " +

        " -samplegroup Input " +

        " -samplegroup Media " +

        " -samplegroup Notification " +

        " -samplegroup RenderScript " +

        " -samplegroup Security " +

        " -samplegroup Sensors " +

        " -samplegroup System " +

        " -samplegroup Testing " +

        " -samplegroup UI " +

        " -samplegroup Views " +

        " -samplegroup Wearable -samplesdir development/samples/browseable ",

}



droiddoc {

    name: "hidden-docs",

    defaults: ["framework-docs-default"],

    proofread_file: "hidden-docs-proofrerad.txt",

    args: framework_docs_args +

          " -referenceonly " +

          " -title \"Android SDK - Including hidden APIs.\"",

}



droiddoc {

    name: "hwbinder-stubs-docs",

    srcs: [
@@ -1036,12 +1312,13 @@ java_library_static { 


droiddoc {

    name: "hiddenapi-lists",

    defaults: ["framework-docs-default"],

    defaults: ["api-stubs-default"],

    arg_files: [

        "core/res/AndroidManifest.xml",

        ":api-version-xml",

        "core/java/overview.html",

        ":current-support-api",

        "api/current.txt",

    ],

    dex_api_filename: "public-dex.txt",

    private_dex_api_filename: "private-dex.txt",
@@ -1056,12 +1333,13 @@ droiddoc { 


droiddoc {

    name: "hiddenapi-mappings",

    defaults: ["framework-docs-default"],

    defaults: ["api-stubs-default"],

    arg_files: [

        "core/res/AndroidManifest.xml",

        ":api-version-xml",

        "core/java/overview.html",

        ":current-support-api",

        "api/current.txt",

    ],

    dex_mapping_filename: "dex-mapping.txt",

    args: framework_docs_args +
@@ -1105,7 +1383,7 @@ metalava_framework_docs_args = "--manifest $(location core/res/AndroidManifest.x 
    "--hide SdkConstant --hide HiddenTypeParameter --hide Todo --hide Typo"



doc_defaults {

    name: "metalava-framework-docs-default",

    name: "metalava-api-stubs-default",

    srcs: [

        // test mock src files.

        "test-mock/src/android/test/mock/**/*.java",
@@ -1148,7 +1426,7 @@ doc_defaults { 


droiddoc {

    name: "metalava-api-stubs-docs",

    defaults: ["metalava-framework-docs-default"],

    defaults: ["metalava-api-stubs-default"],

    api_tag_name: "METALAVA_PUBLIC",

    api_filename: "public_api.txt",

    private_api_filename: "private.txt",
@@ -1161,7 +1439,7 @@ droiddoc { 


droiddoc {

    name: "metalava-system-api-stubs-docs",

    defaults: ["metalava-framework-docs-default"],

    defaults: ["metalava-api-stubs-default"],

    api_tag_name: "METALAVA_SYSTEM",

    api_filename: "system-api.txt",

    private_api_filename: "system-private.txt",
@@ -1175,7 +1453,7 @@ droiddoc { 


droiddoc {

    name: "metalava-test-api-stubs-docs",

    defaults: ["metalava-framework-docs-default"],

    defaults: ["metalava-api-stubs-default"],

    api_tag_name: "METALAVA_TEST",

    api_filename: "test-api.txt",

    removed_api_filename: "test-removed.txt",

Android.mk

+7 −312

File changed.

Preview size limit exceeded, changes collapsed.