Report style for documentation.
diff --git a/org.jacoco.doc/buildhook.xml b/org.jacoco.doc/buildhook.xml
index 681704b..beac90b 100644
--- a/org.jacoco.doc/buildhook.xml
+++ b/org.jacoco.doc/buildhook.xml
@@ -34,7 +34,11 @@
</javadoc>
<copy todir="${result.dist.dir}">
- <fileset dir="${source.bundle.dir}/docroot" includes="**/*"/>
+ <fileset dir="${source.bundle.dir}/docroot" includes="**/*" excludes="**/*.html"/>
+ </copy>
+
+ <copy todir="${result.dist.dir}">
+ <fileset dir="${source.bundle.dir}/docroot" includes="**/*.html"/>
<filterset>
<filter token="VERSION" value="${qualified.bundle.version}"/>
</filterset>
diff --git a/org.jacoco.doc/docroot/doc/.resources/doc.css b/org.jacoco.doc/docroot/doc/.resources/doc.css
new file mode 100644
index 0000000..af58bad
--- /dev/null
+++ b/org.jacoco.doc/docroot/doc/.resources/doc.css
@@ -0,0 +1,122 @@
+body, td {
+ font-family:sans-serif;
+ font-size:10pt;
+}
+
+h1 {
+ font-weight:bold;
+ font-size:18pt;
+}
+
+.breadcrumb {
+ border:#d6d3ce 1px solid;
+ padding:2px 2px 2px 2px;
+}
+
+.footer {
+ border-top:#d6d3ce 1px solid;
+ padding-top:2px;
+ font-size:8pt;
+ color:#a0a0a0;
+}
+
+.footer a {
+ color:#a0a0a0;
+}
+
+.el_session {
+ padding-left:18px;
+ background-image:url(session.gif);
+ background-repeat:no-repeat;
+}
+
+.el_group {
+ padding-left:18px;
+ background-image:url(group.gif);
+ background-repeat:no-repeat;
+}
+
+.el_source {
+ padding-left:18px;
+ background-image:url(source.gif);
+ background-position:left center;
+ background-repeat:no-repeat;
+}
+
+pre.source {
+ border:#d6d3ce 1px solid;
+ font-family:monospace;
+}
+
+pre.source span.nr {
+ color:#c0c0c0;
+ border-right:#d6d3ce 1px solid;
+ padding-right:2pt;
+}
+
+pre.source span.fc {
+ background-color:#ccffcc;
+}
+
+pre.source span.nc {
+ background-color:#ffcccc;
+}
+
+pre.source span.pc {
+ background-color:#ffffcc;
+}
+
+
+table.coverage {
+ empty-cells:show;
+ border-collapse:collapse;
+}
+
+table.coverage thead {
+ background-color:#e0e0e0;
+}
+
+table.coverage thead td {
+ border-bottom:#b0b0b0 1px solid;
+ padding:2px 12px 0px 6px;
+}
+
+table.coverage td {
+ white-space:nowrap;
+ padding:2px 12px 2px 6px;
+}
+
+table.coverage tbody tr:hover {
+ background: #f0f0d0 !important;
+}
+
+table.coverage tbody td {
+ border-bottom:#d6d3ce 1px solid;
+}
+
+table.coverage td.ctr1 {
+ text-align:right;
+ padding:2px 0px 2px 12px;
+}
+
+table.coverage td.ctr2 {
+ text-align:right;
+ padding:2px 0px 2px 4px;
+}
+
+table.coverage td.ctr3 {
+ text-align:right;
+ padding:2px 12px 2px 4px;
+}
+
+p.intro {
+ margin-left:20px;
+ padding-left:4px;
+ border-left:#cccca0 4px solid;
+ font-style:italic
+}
+
+.high {
+ background-color:#ffff80;
+}
+
diff --git a/org.jacoco.doc/docroot/doc/.resources/group.gif b/org.jacoco.doc/docroot/doc/.resources/group.gif
new file mode 100644
index 0000000..a4ea580
--- /dev/null
+++ b/org.jacoco.doc/docroot/doc/.resources/group.gif
Binary files differ
diff --git a/org.jacoco.doc/docroot/doc/.resources/session.gif b/org.jacoco.doc/docroot/doc/.resources/session.gif
new file mode 100644
index 0000000..8547be5
--- /dev/null
+++ b/org.jacoco.doc/docroot/doc/.resources/session.gif
Binary files differ
diff --git a/org.jacoco.doc/docroot/doc/.resources/source.gif b/org.jacoco.doc/docroot/doc/.resources/source.gif
new file mode 100644
index 0000000..b226e41
--- /dev/null
+++ b/org.jacoco.doc/docroot/doc/.resources/source.gif
Binary files differ
diff --git a/org.jacoco.doc/docroot/doc/book.css b/org.jacoco.doc/docroot/doc/book.css
deleted file mode 100644
index adde819..0000000
--- a/org.jacoco.doc/docroot/doc/book.css
+++ /dev/null
@@ -1,167 +0,0 @@
-P.Code {
- display: block;
- text-align: left;
- text-indent: 0.00pt;
- margin-top: 0.000000pt;
- margin-bottom: 0.000000pt;
- margin-right: 0.000000pt;
- margin-left: 15pt;
- font-size: 10.000000pt;
- color: #4444CC;
- text-decoration: none;
- vertical-align: baseline;
- text-transform: none;
- font-family: "Courier New";
-}
-H6.CaptionFigColumn {
- display: block;
- text-align: left;
- text-indent: 0.000000pt;
- margin-top: 3.000000pt;
- margin-bottom: 11.000000pt;
- margin-right: 0.000000pt;
- margin-left: 0.000000pt;
- font-size: 9.000000pt;
- font-style: Italic;
- color: #000000;
- text-decoration: none;
- vertical-align: baseline;
- text-transform: none;
- font-family: "Arial";
-}
-P.Note {
- display: block;
- text-align: left;
- text-indent: 0pt;
- margin-top: 19.500000pt;
- margin-bottom: 19.500000pt;
- margin-right: 0.000000pt;
- margin-left: 30pt;
- font-size: 11.000000pt;
- font-style: Italic;
- color: #000000;
- text-decoration: none;
- vertical-align: baseline;
- text-transform: none;
- font-family: "Arial";
-}
-EM.UILabel {
- font-weight: Bold;
- text-decoration: none;
- vertical-align: baseline;
- text-transform: none;
-}
-EM.CodeName {
- font-weight: Bold;
- text-decoration: none;
- vertical-align: baseline;
- text-transform: none;
- font-family:"Courier New";
-}
-
-body, html { border: 0px }
-
-
-/* following font face declarations need to be removed for DBCS */
-
-body, h1, h2, h3, h4, h5, h6, p, table, td, caption, th, ul, ol, dl, li, dd, dt {font-family: Arial, Helvetica, sans-serif; color: #000000}
-pre { font-family: Courier, monospace}
-
-/* end font face declarations */
-
-/* following font size declarations should be OK for DBCS */
-body, h1, h2, h3, h4, h5, h6, p, table, td, caption, th, ul, ol, dl, li, dd, dt {font-size: 10pt; }
-pre { font-size: 10pt}
-
-/* end font size declarations */
-
-body { background: #FFFFFF}
-h1 { font-size: 18pt; margin-top: 15px; margin-bottom: 3px }
-h2 { font-size: 14pt; margin-top: 20px; margin-bottom: 3px }
-h3 { font-size: 11pt; margin-top: 20px; margin-bottom: 3px }
-h4 { font-size: 10pt; margin-top: 20px; margin-bottom: 3px; font-style: italic }
-p { margin-top: 10px; margin-bottom: 10px }
-pre { margin-left: 6px; font-size: 9pt; color: #4444CC }
-a:link { color: #0000FF }
-a:hover { color: #000080 }
-a:visited { text-decoration: underline }
-ul { margin-top: 0; margin-bottom: 10px }
-li { margin-top: 0; margin-bottom: 0 }
-li p { margin-top: 0; margin-bottom: 0 }
-ol { margin-top: 0; margin-bottom: 10px }
-dl { margin-top: 0; margin-bottom: 10px }
-dt { margin-top: 0; margin-bottom: 0; font-weight: bold }
-dd { margin-top: 0; margin-bottom: 0 }
-strong { font-weight: bold}
-em { font-style: italic}
-var { font-style: italic}
-div.revision { border-left-style: solid; border-left-width: thin;
- border-left-color: #7B68EE; padding-left:5px }
-th { font-weight: bold }
-
-pre.code {
- color: #000000;
- margin: 0px 0px 0px 0px;
- padding: 10px 10px 10px 10px;
- background-color:#e0e0e0;
- border: 1px solid #000000;
-}
-
-div.menu {
- background-image:url(images/topic.gif);
- background-repeat:no-repeat;
- background-position:left center;
- padding-left:17px;
- white-space:nowrap;
- margin-bottom:2pt;
-}
-div.menu a {
- color:#000000;
- text-decoration:none;
-}
-div.menu a:visited {
- color:#000000;
- text-decoration:none;
-}
-div.menu a:hover {
- text-decoration:underline;
-}
-div.menuhi {
- color:#ffffff;
- background-color:#000080;
- background-image:url(images/topic.gif);
- background-repeat:no-repeat;
- background-position:left center;
- padding-left:17px;
- white-space:nowrap;
- margin-bottom:2pt;
-}
-div.menuhi a {
- color:#ffffff;
- text-decoration:none;
-}
-div.menuhi a:visited {
- color:#ffffff;
- text-decoration:none;
-}
-div.menuhi a:hover {
- text-decoration:underline;
-}
-
-a.extern {
- background-image:url(images/extern.gif);
- background-repeat:no-repeat;
- background-position:left center;
- padding-left:15px;
-}
-
-td.footer {
- color:#8998a5;
- font-size:8pt;
-}
-td.footer a {
- color:#8998a5;
-}
-.high {
- background-color:#ffff80;
-}
\ No newline at end of file
diff --git a/org.jacoco.doc/docroot/doc/empty.html b/org.jacoco.doc/docroot/doc/empty.html
index ca820d4..3917377 100644
--- a/org.jacoco.doc/docroot/doc/empty.html
+++ b/org.jacoco.doc/docroot/doc/empty.html
@@ -3,20 +3,26 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
- <link rel="stylesheet" href="book.css" charset="ISO-8859-1" type="text/css" />
+ <link rel="stylesheet" href=".resources/doc.css" charset="ISO-8859-1" type="text/css" />
<title>JaCoCo - XXX TITLE XXX</title>
</head>
<body>
-<h1>Headline</h1>
+<div class="breadcrumb">
+ <a href="../index.html" class="el_session">JaCoCo</a> >
+ <span class="el_source">Title</span>
+</div>
+
+<h1>Title</h1>
<p>
Text
</p>
-<hr/>
-<div style="float:right">@VERSION@</div>
-<div>Copyright © 2009 Mountainminds GmbH & Co. KG, Marc R. Hoffmann</div>
+<div class="footer">
+ <div style="float:right">@VERSION@</div>
+ <a href="license.html">Copyright</a> © 2009 Mountainminds GmbH & Co. KG and Contributors
+</div>
</body>
</html>
\ No newline at end of file
diff --git a/org.jacoco.doc/docroot/doc/implementation.html b/org.jacoco.doc/docroot/doc/implementation.html
index d05b101..e99e049 100644
--- a/org.jacoco.doc/docroot/doc/implementation.html
+++ b/org.jacoco.doc/docroot/doc/implementation.html
@@ -3,12 +3,18 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
- <link rel="stylesheet" href="book.css" charset="ISO-8859-1" type="text/css" />
+ <link rel="stylesheet" href=".resources/doc.css" charset="ISO-8859-1" type="text/css" />
<title>JaCoCo - Implementation Design</title>
</head>
<body>
-<h1>JaCoCo - Implementation Design</h1>
+<div class="breadcrumb">
+ <a href="../index.html" class="el_session">JaCoCo</a> >
+ <a href="index.html" class="el_group">Documentation</a> >
+ <span class="el_source">Implementation Design</span>
+</div>
+
+<h1>Implementation Design</h1>
<p>
This is a unordered list of implementation design decisions. Each topic tries
@@ -24,7 +30,7 @@
<h2>Coverage Analysis Mechanism</h2>
-<p class="Note">
+<p class="intro">
Coverage information has to be collected at runtime. For this purpose JaCoCo
creates instrumented versions of the original class definitions. The
instrumentation process happens on-the-fly during class loading using so
@@ -86,7 +92,7 @@
<h2>Instrumentation Approach</h2>
-<p class="Note">
+<p class="intro">
Instrumentation means inserting probes at certain check points in the Java
byte code. A probe generated piece of byte code that records the fact that it
has been executed. JaCoCo inserts probes at the end of every basic block.
@@ -125,7 +131,7 @@
<h2>Coverage Agent Isolation</h2>
-<p class="Note">
+<p class="intro">
The Java agent is loaded by the application class loader. Therefore the
classes of the agent live in the same name space than the application classes
which can result in clashes especially with the third party library ASM. The
@@ -144,7 +150,7 @@
<h2>Minimal Java Version</h2>
-<p class="Note">
+<p class="intro">
JaCoCo requires Java 1.5.
</p>
@@ -158,7 +164,7 @@
<h2>Byte Code Manipulation</h2>
-<p class="Note">
+<p class="intro">
Instrumentation requires mechanisms to modify and generate Java byte code.
JaCoCo uses the ASM library for this purpose.
</p>
@@ -174,7 +180,7 @@
<h2>Java Class Identity</h2>
-<p class="Note">
+<p class="intro">
Each class loaded at runtime needs a unique identity to associate coverage data with.
JaCoCo creates such identities by a CRC64 hash code of the raw class definition.
</p>
@@ -206,7 +212,7 @@
<h2>Coverage Runtime Dependency</h2>
-<p class="Note">
+<p class="intro">
Instrumented code typically gets a dependency to a coverage runtime which is
responsible for collecting and storing execution data. JaCoCo uses JRE types
and interfaces only in generated instrumentation code.
@@ -221,7 +227,7 @@
<h2>Memory Usage</h2>
-<p class="Note">
+<p class="intro">
</p>
@@ -231,7 +237,7 @@
<h2>Java Element Identifiers</h2>
-<p class="Note">
+<p class="intro">
The Java language and the Java VM use different String representation formats
for Java elements. For example while a type reference in Java reads like
<code>java.lang.Object</code>, the VM references the same type as
@@ -247,7 +253,7 @@
<h2>Modularization of the JaCoCo implementation</h2>
-<p class="Note">
+<p class="intro">
JaCoCo is implemented in several modules providing different functionality.
These modules are provided as OSGi bundles with proper manifest files. But
there is no dependencies on OSGi itself.
@@ -259,10 +265,10 @@
bundles can also be used as regular JAR files.
</p>
-
-<hr/>
-<div style="float:right">@VERSION@</div>
-<div>Copyright © 2009 Mountainminds GmbH & Co. KG, Marc R. Hoffmann</div>
+<div class="footer">
+ <div style="float:right">@VERSION@</div>
+ <a href="license.html">Copyright</a> © 2009 Mountainminds GmbH & Co. KG and Contributors
+</div>
</body>
</html>
\ No newline at end of file
diff --git a/org.jacoco.doc/docroot/doc/index.html b/org.jacoco.doc/docroot/doc/index.html
index f663ec0..6d80eab 100644
--- a/org.jacoco.doc/docroot/doc/index.html
+++ b/org.jacoco.doc/docroot/doc/index.html
@@ -3,24 +3,31 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
- <link rel="stylesheet" href="book.css" charset="ISO-8859-1" type="text/css" />
+ <link rel="stylesheet" href=".resources/doc.css" charset="ISO-8859-1" type="text/css" />
<title>JaCoCo - Documentation</title>
</head>
<body>
-<h1>JaCoCo - Documentation</h1>
+<div class="breadcrumb">
+ <a href="../index.html" class="el_session">JaCoCo</a> >
+ <span class="el_group">Documentation</span>
+</div>
+
+<h1>Documentation</h1>
<h2>Contents</h2>
<ul>
+ <li><a href="mission.html">Mission</a></li>
<li><a href="implementation.html">Implementation Design</a></li>
<li><a href="api/index.html">API Documentation (JavaDoc)</a></li>
<li><a href="license.html">License</a></li>
</ul>
-<hr/>
-<div style="float:right">@VERSION@</div>
-<div>Copyright © 2009 Mountainminds GmbH & Co. KG, Marc R. Hoffmann</div>
+<div class="footer">
+ <div style="float:right">@VERSION@</div>
+ <a href="license.html">Copyright</a> © 2009 Mountainminds GmbH & Co. KG and Contributors
+</div>
</body>
</html>
\ No newline at end of file
diff --git a/org.jacoco.doc/docroot/doc/license.html b/org.jacoco.doc/docroot/doc/license.html
index 9d791aa..a9cd572 100644
--- a/org.jacoco.doc/docroot/doc/license.html
+++ b/org.jacoco.doc/docroot/doc/license.html
@@ -3,17 +3,22 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
- <link rel="stylesheet" href="book.css" charset="ISO-8859-1" type="text/css" />
+ <link rel="stylesheet" href=".resources/doc.css" charset="ISO-8859-1" type="text/css" />
<title>JaCoCo - License</title>
</head>
<body>
-<h1>JaCoCo - License</h1>
+<div class="breadcrumb">
+ <a href="../index.html" class="el_session">JaCoCo</a> >
+ <span class="el_source">License</span>
+</div>
+
+<h1>License</h1>
<p>
- The JaCoCo Java Code Coverage Library is made available by Mountainminds GmbH
- & Co. KG, Munich. Except indicated below, the Content is provided to you
- under the terms and conditions of the Eclipse Public License Version 1.0
+ The JaCoCo Java Code Coverage Library and all included documentation is made available
+ by Mountainminds GmbH & Co. KG, Munich. Except indicated below, the Content is
+ provided to you under the terms and conditions of the Eclipse Public License Version 1.0
("EPL"). A copy of the EPL is available at
<a href="http://www.eclipse.org/legal/epl-v10.html">http://www.eclipse.org/legal/epl-v10.html</a>.
</p>
@@ -57,9 +62,10 @@
THE POSSIBILITY OF SUCH DAMAGE.
</pre>
-<hr/>
-<div style="float:right">@VERSION@</div>
-<div>Copyright © 2009 Mountainminds GmbH & Co. KG, Marc R. Hoffmann</div>
+<div class="footer">
+ <div style="float:right">@VERSION@</div>
+ <a href="license.html">Copyright</a> © 2009 Mountainminds GmbH & Co. KG and Contributors
+</div>
</body>
</html>
\ No newline at end of file
diff --git a/org.jacoco.doc/docroot/doc/mission.html b/org.jacoco.doc/docroot/doc/mission.html
new file mode 100644
index 0000000..a490c23
--- /dev/null
+++ b/org.jacoco.doc/docroot/doc/mission.html
@@ -0,0 +1,52 @@
+<?xml version="1.0" encoding="ISO-8859-1" ?>
+<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
+<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
+<head>
+ <meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
+ <link rel="stylesheet" href=".resources/doc.css" charset="ISO-8859-1" type="text/css" />
+ <title>JaCoCo - Mission</title>
+</head>
+<body>
+
+<div class="breadcrumb">
+ <a href="../index.html" class="el_session">JaCoCo</a> >
+ <span class="el_source">Mission</span>
+</div>
+
+<h1>Mission</h1>
+
+<p class="intro">
+ JaCoCo should become the standard tool for instrumentation based code coverage
+ in Java VM based environments. The focus is providing a lightweight, flexible
+ and well documented library for integration with various build and development
+ tools.
+</p>
+
+<p>
+ There are several open source coverage technologies for Java. While
+ implementing the Eclipse plug-in <a href="http://www.eclemma.org/">EclEmma</a>
+ the observation was that none of them are really designed for integration.
+ Most of them are build for a particular tool (Ant tasks, command line, IDE
+ plug-in) and do not offer a documented API that allows embedding in different
+ contexts. One of the best and widely used available open source tools is
+ <a href="http://emma.sourceforge.net/">EMMA</a>. While EclEmma is based on it
+ the EMMA library is not actively maintained any more by the original author.
+ Due to the lack of regression tests maintenance and feature additions will
+ become very difficult.
+</p>
+
+<p>
+ JaCoCo should become the standard tool for instrumentation based code coverage
+ in Java VM based environments. The focus is providing a lightweight, flexible
+ and well documented library for integration with various build and development
+ tools. Ant tasks are provided as reference usage scenarios. Other tools like a
+ ready to use Eclipse plug-in (future version of EclEmma) might follow.
+</p>
+
+<div class="footer">
+ <div style="float:right">@VERSION@</div>
+ <a href="license.html">Copyright</a> © 2009 Mountainminds GmbH & Co. KG and Contributors
+</div>
+
+</body>
+</html>
\ No newline at end of file
diff --git a/org.jacoco.doc/docroot/index.html b/org.jacoco.doc/docroot/index.html
index d2de6e6..8fc3feb 100644
--- a/org.jacoco.doc/docroot/index.html
+++ b/org.jacoco.doc/docroot/index.html
@@ -3,16 +3,21 @@
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=ISO-8859-1" />
- <link rel="stylesheet" href="doc/book.css" charset="ISO-8859-1" type="text/css" />
+ <link rel="stylesheet" href="doc/.resources/doc.css" charset="ISO-8859-1" type="text/css" />
<title>JaCoCo - Java Code Coverage Library</title>
</head>
<body>
+<div class="breadcrumb">
+ <span class="el_session">JaCoCo</span>
+</div>
+
<h1>JaCoCo - Java Code Coverage Library</h1>
<p>
- JaCoCo is a free Java code coverage library implemented by Marc R. Hoffmann.
- Check <a href="http://www.eclemma.org/devdoc/jacoco.html">http://www.eclemma.org/devdoc/jacoco.html</a>
+ JaCoCo is a free Java code coverage library implemented by Marc R. Hoffmann and
+ Brock Janiczak. Check
+ <a href="http://www.eclemma.org/devdoc/jacoco.html">http://www.eclemma.org/devdoc/jacoco.html</a>
for updates, documentation and support.
</p>
@@ -37,9 +42,10 @@
<li>All JARs in the <code>lib/</code> folder</li>
</ul>
-<hr/>
-<div style="float:right">@VERSION@</div>
-<div>Copyright © 2009 Mountainminds GmbH & Co. KG, Marc R. Hoffmann</div>
+<div class="footer">
+ <div style="float:right">@VERSION@</div>
+ <a href="doc/license.html">Copyright</a> © 2009 Mountainminds GmbH & Co. KG and Contributors
+</div>
</body>
</html>
\ No newline at end of file
