Add introduction to the API reference

elicec · Apr 1, 2016 · 19a0549 · 19a0549
1 parent 1fb1e93
commit 19a0549
Show file tree

Hide file tree

Showing 3 changed files with 20 additions and 1 deletion.
diff --git a/app/build.gradle b/app/build.gradle
@@ -53,14 +53,17 @@ android {
 task generateDocs(type: Javadoc, dependsOn: 'compileReleaseSources') {
     source = file('src/main/java')
     ext.templateDir = file('doclib/template')
+    ext.overviewFile = file('doclib/overview.html')
     inputs.dir ext.templateDir
+    inputs.file ext.overviewFile
     title = null
 
     options {
         doclet = 'com.google.doclava.Doclava'
         docletpath = fileTree(dir: 'doclib', include: '**/*.jar').asType(List)
         jFlags '-Dignore.symbol.file'
         addFileOption 'templatedir', ext.templateDir
+        addFileOption 'overview', ext.overviewFile
         addBooleanOption 'nodefaultassets', true
         addStringOption 'hdf android.whichdoc', 'offline'
         addStringOption 'federate android', 'http://developer.android.com'

diff --git a/app/doclib/overview.html b/app/doclib/overview.html
@@ -0,0 +1,14 @@
+<body>
+Welcome to the Javadoc reference of the <b>Xposed Framework API</b>. It's meant for module developers who want to understand which classes and methods they can use. The most ones are:
+
+<ul>
+  <li style="margin: 0;">{@link de.robv.android.xposed.IXposedHookZygoteInit}</li>
+  <li style="margin: 0;">{@link de.robv.android.xposed.IXposedHookLoadPackage}</li>
+  <li style="margin: 0;">{@link de.robv.android.xposed.XposedHelpers#findAndHookMethod(String, ClassLoader, String, Object...) XposedHelpers.findAndHookMethod()}</li>
+  <li style="margin: 0;">{@link de.robv.android.xposed.IXposedHookInitPackageResources}</li>
+  <li style="margin: 0;">{@link android.content.res.XResources#setReplacement(String, String, String, Object) XResources.setReplacement()}
+</ul>
+
+If you're completely new to writing modules, you should read the <b><a href="https://github.com/rovo89/XposedBridge/wiki/Development-tutorial">tutorial</a></b> first.
+In case of questions, someone on <b><a href="http://forum.xda-developers.com/xposed/development">XDA</a></b> can probably help you (if you describe exactly what you're trying to do and what you've already tried).
+</body>
diff --git a/app/doclib/template/packages.cs b/app/doclib/template/packages.cs
@@ -1,3 +1,4 @@
+<?cs set:page.title = '' ?>
 <?cs include:"doctype.cs" ?>
 <?cs include:"macros.cs" ?>
 <html<?cs if:devsite ?> devsite<?cs /if ?>>
@@ -15,7 +16,7 @@
 <div class="col-12" id="doc-col">
 
 <div id="jd-header">
-<h1><?cs var:page.title ?></h1>
+<h1>Overview</h1>
 </div>
 
 <div id="jd-content">
@@ -24,6 +25,7 @@
 <p><?cs call:tag_list(root.descr) ?></p>
 </div>
 
+<h2>Packages Index:</h2>
 <?cs set:count = #1 ?>
 <table class="jd-sumtable">
 <?cs each:pkg = docs.packages ?>