diff options
author | Clay Murphy <claym@google.com> | 2014-03-24 18:05:16 -0700 |
---|---|---|
committer | Clay Murphy <claym@google.com> | 2014-10-30 14:57:30 -0700 |
commit | 28730d1e776bc55a63530b4f6ab810f2b7745654 (patch) | |
tree | da16bc9a6da83b97ca8625692e892e941822c198 | |
parent | 703d1136ca2698a432d93bd1ee07062958d7c69b (diff) | |
download | source.android.com-28730d1e776bc55a63530b4f6ab810f2b7745654.tar.gz |
Docs: Better integrating HAL contents into source.android.com
Bug: 12067952, 12228517
Change-Id: I741e03ee9ee5070960dc7687f5f49e840b31a401
-rw-r--r-- | Doxyfile | 14 | ||||
-rw-r--r-- | DoxygenLayout.xml | 4 | ||||
-rw-r--r-- | hal_doxygen.css | 35 | ||||
-rw-r--r-- | hal_footer.html | 22 | ||||
-rw-r--r-- | hal_header.html | 46 | ||||
-rw-r--r-- | src/devices/audio.jd | 2 | ||||
-rw-r--r-- | src/devices/devices_toc.cs | 2 | ||||
-rw-r--r-- | src/devices/tech/index.jd | 2 |
8 files changed, 115 insertions, 12 deletions
@@ -925,7 +925,7 @@ GENERATE_HTML = YES # If a relative path is entered the value of OUTPUT_DIRECTORY will be # put in front of it. If left blank `html' will be used as the default path. -HTML_OUTPUT = reference +HTML_OUTPUT = halref # The HTML_FILE_EXTENSION tag can be used to specify the file extension for # each generated HTML page (for example: .htm,.php,.asp). If it is left blank @@ -944,13 +944,13 @@ HTML_FILE_EXTENSION = .html # have to redo this when upgrading to a newer version of doxygen or when # changing the value of configuration settings such as GENERATE_TREEVIEW! -HTML_HEADER = +HTML_HEADER = ./docs/source.android.com/hal_header.html # The HTML_FOOTER tag can be used to specify a personal HTML footer for # each generated HTML page. If it is left blank doxygen will generate a # standard footer. -HTML_FOOTER = +HTML_FOOTER = ./docs/source.android.com/hal_footer.html # The HTML_STYLESHEET tag can be used to specify a user-defined cascading # style sheet that is used by each HTML page. It can be used to @@ -969,7 +969,7 @@ HTML_STYLESHEET = # robust against future updates. Doxygen will copy the style sheet file to # the output directory. -HTML_EXTRA_STYLESHEET = +HTML_EXTRA_STYLESHEET = ./docs/source.android.com/hal_doxygen.css # The HTML_EXTRA_FILES tag can be used to specify one or more extra images or # other source files which should be copied to the HTML output directory. Note @@ -994,7 +994,7 @@ HTML_COLORSTYLE_HUE = 220 # the colors in the HTML output. For a value of 0 the output will use # grayscales only. A value of 255 will produce the most vivid colors. -HTML_COLORSTYLE_SAT = 100 +HTML_COLORSTYLE_SAT = 0 # The HTML_COLORSTYLE_GAMMA tag controls the gamma correction applied to # the luminance component of the colors in the HTML output. Values below @@ -1185,7 +1185,7 @@ ECLIPSE_DOC_ID = org.doxygen.Project # navigation tree you can set this option to NO if you already set # GENERATE_TREEVIEW to YES. -DISABLE_INDEX = NO +DISABLE_INDEX = YES # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # structure should be generated to display hierarchical information. @@ -1197,7 +1197,7 @@ DISABLE_INDEX = NO # Since the tree basically has the same information as the tab index you # could consider to set DISABLE_INDEX to NO when enabling this option. -GENERATE_TREEVIEW = NO +GENERATE_TREEVIEW = YES # The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values # (range [0,1..20]) that doxygen will group on one line in the generated HTML diff --git a/DoxygenLayout.xml b/DoxygenLayout.xml index f2643862..4b6ad40f 100644 --- a/DoxygenLayout.xml +++ b/DoxygenLayout.xml @@ -2,7 +2,7 @@ <!-- Generated by doxygen 1.8.3.1 --> <!-- Navigation index tabs for HTML output --> <navindex> - <tab type="mainpage" visible="yes" title="" intro="fdsfds"/> + <tab type="mainpage" visible="yes" title="" intro=""/> <tab type="pages" visible="yes" title="" intro=""/> <tab type="modules" visible="yes" title="" intro=""/> <tab type="namespaces" visible="yes" title=""> @@ -18,7 +18,7 @@ <tab type="filelist" visible="yes" title="" intro=""/> <tab type="globals" visible="yes" title="" intro=""/> </tab> - <tab type="user" url="/devices/index.html" title="Back to source.android.com"> + <tab type="user" url="/devices/tech/index.html" title="Devices on source.android.com"> </tab> </navindex> diff --git a/hal_doxygen.css b/hal_doxygen.css new file mode 100644 index 00000000..6e63946d --- /dev/null +++ b/hal_doxygen.css @@ -0,0 +1,35 @@ +#header { + padding: 1.2em 0 0.2em 0; + margin: 10px 120px; +} + +a:hover, +acronym:hover { + color: #7aa1b0 !important; } + +a:link, a:visited { + color: #258aaf; + text-decoration: none; +} + +a:focus, a:hover, a:active { + color: #33b5e5; + text-decoration: none; +} + +a.toptab { + color: #333; + font-size: 16px; +} + +a.devices { + color: #F80; + font-size: 16px; +} + +hr.light { + border: 0; + height: 0; + border-top: 1px solid rgba(0, 0, 0, 0.1); + border-bottom: 1px solid rgba(255, 255, 255, 0.3); +} diff --git a/hal_footer.html b/hal_footer.html new file mode 100644 index 00000000..2ad5ca35 --- /dev/null +++ b/hal_footer.html @@ -0,0 +1,22 @@ +<!-- HTML footer for doxygen 1.8.4--> +<!-- start footer part --> +<!--BEGIN GENERATE_TREEVIEW--> +<div id="nav-path" class="navpath"><!-- id is needed for treeview function! --> + <ul> + $navpath + <li class="footer">$generatedby + <a href="/index.html"> + <img class="footer" src="/images/Android_Robot_100.png" alt="Android"/></a> $doxygenversion </li> + </ul> +</div> +<!--END GENERATE_TREEVIEW--> +<!--BEGIN !GENERATE_TREEVIEW--> +<hr class="footer"/><address class="footer"><small> +$generatedby  <a href="/index.html"> +<img class="footer" +src="/images/Android_Robot_100.png" alt="Android"/> +</a> $doxygenversion +</small></address> +<!--END !GENERATE_TREEVIEW--> +</body> +</html> diff --git a/hal_header.html b/hal_header.html new file mode 100644 index 00000000..dc4e6716 --- /dev/null +++ b/hal_header.html @@ -0,0 +1,46 @@ +<!-- HTML header for doxygen 1.8.4--> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> +<html xmlns="http://www.w3.org/1999/xhtml"> +<head> +<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/> +<meta http-equiv="X-UA-Compatible" content="IE=9"/> +<meta name="generator" content="Doxygen $doxygenversion"/> +<!--BEGIN PROJECT_NAME--><title>$projectname: $title</title><!--END PROJECT_NAME--> +<!--BEGIN !PROJECT_NAME--><title>$title</title><!--END !PROJECT_NAME--> +<link href="$relpath^tabs.css" rel="stylesheet" type="text/css"/> +<script type="text/javascript" src="//www.gstatic.com/external_hosted/source_android_com/sac_doxygen_jquery.js"></script> +<script type="text/javascript" src="$relpath^dynsections.js"></script> +$treeview +$search +$mathjax +<link href="$relpath^$stylesheet" rel="stylesheet" type="text/css" /> +$extrastylesheet +<script type="text/javascript"> + var _gaq = _gaq || []; + _gaq.push(['_setAccount', 'UA-45455297-1']); + _gaq.push(['_trackPageview']); + + (function() { + var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true; + ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js'; + var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s); + })(); +</script> +</head> +<body> +<div id="top"><!-- do not remove this div, it is closed by doxygen! --> + + <div id="header"> + <table width=80%> + <tr> + <td><a href="/index.html"><img src="/assets/images/sac_logo.png" width="123" height="25" alt="Android Developers" /></td> + <td><a class=toptab href="/source/index.html">Source</a></td> + <td><a class=devices href="/devices/index.html">Devices</a></td> + <td><a class=toptab href="/accessories/index.html">Accessories</a></td> + <td><a class=toptab href="/compatibility/index.html">Compatibility</a></td> + <td width=20%>$searchbox</td> + </tr> + </table> + </div> +<hr class=light> +<!-- end header part --> diff --git a/src/devices/audio.jd b/src/devices/audio.jd index 1b85d5e0..660ec7ee 100644 --- a/src/devices/audio.jd +++ b/src/devices/audio.jd @@ -78,7 +78,7 @@ page.title=Audio and that you must implement to have your audio hardware function correctly. The audio HAL interfaces are located in <code>hardware/libhardware/include/hardware</code>. See <a -href="http://source.android.com/devices/reference/audio_8h_source.html">audio.h</a> for additional details. +href="{@docRoot}devices/halref/audio_8h_source.html">audio.h</a> for additional details. </dd> <dt> Kernel Driver diff --git a/src/devices/devices_toc.cs b/src/devices/devices_toc.cs index 93da9f4f..3e3ce4c4 100644 --- a/src/devices/devices_toc.cs +++ b/src/devices/devices_toc.cs @@ -294,7 +294,7 @@ <li class="nav-section"> <div class="nav-section-header empty"> - <a href="<?cs var:toroot ?>devices/reference/files.html"> + <a href="<?cs var:toroot ?>devices/halref/index.html"> <span class="en">HAL File Reference</span> </a> </div> diff --git a/src/devices/tech/index.jd b/src/devices/tech/index.jd index fbb4cc7a..4fbf4420 100644 --- a/src/devices/tech/index.jd +++ b/src/devices/tech/index.jd @@ -60,7 +60,7 @@ about debugging at the platform level.</p> <p>Android's Hardware Abstraction Layer (HAL) provides the interface between software APIs and hardware drivers. This section contains the commented code files of the HAL.</p> -<p><a href="{@docRoot}devices/reference/files.html">» HAL Reference</a></p> +<p><a href="{@docRoot}devices/halref/files.html">» HAL Reference</a></p> <h2 id="kernel-technical-information">Kernel Technical Information</h2> <p>The kernel configuration settings in this document are meant to be used as a base |