Repository: reef
Updated Branches:
refs/heads/master 6c954ff0f -> 0bd7114ef
[REEF-1115] Increase maximum depth of package name of Tint and fix example
images
This change:
* Increases the minimum depth of package name in `Tint.java`
to adapt to the change of package prefix from `com.microsoft`
to `org.apache.reef`.
* Replaces `com.microsoft` with `org.apache.reef` in `tangdoc.png`
and `tooltip.png`.
* Replaces the font 'Comic Sans MS' with 'Helvetica'.
* Updates usage instructions for `Tint`.
JIRA:
[REEF-1115](https://issues.apache.org/jira/browse/REEF-1115)
Pull Request:
This closes #750
Project: http://git-wip-us.apache.org/repos/asf/reef/repo
Commit: http://git-wip-us.apache.org/repos/asf/reef/commit/0bd7114e
Tree: http://git-wip-us.apache.org/repos/asf/reef/tree/0bd7114e
Diff: http://git-wip-us.apache.org/repos/asf/reef/diff/0bd7114e
Branch: refs/heads/master
Commit: 0bd7114efd6676927c0dc781707961d1b39ddaa0
Parents: 6c954ff
Author: Dongjoon Hyun <[email protected]>
Authored: Sat Dec 26 22:04:13 2015 -0800
Committer: Mariia Mykhailova <[email protected]>
Committed: Wed Jan 13 15:23:20 2016 -0800
----------------------------------------------------------------------
lang/java/reef-tang/README.md | 6 +++---
lang/java/reef-tang/doc/tangdoc.png | Bin 32351 -> 255603 bytes
lang/java/reef-tang/doc/tooltip.png | Bin 9677 -> 53516 bytes
.../java/org/apache/reef/tang/util/Tint.java | 4 ++--
4 files changed, 5 insertions(+), 5 deletions(-)
----------------------------------------------------------------------
http://git-wip-us.apache.org/repos/asf/reef/blob/0bd7114e/lang/java/reef-tang/README.md
----------------------------------------------------------------------
diff --git a/lang/java/reef-tang/README.md b/lang/java/reef-tang/README.md
index 6dc14c0..a53caf0 100644
--- a/lang/java/reef-tang/README.md
+++ b/lang/java/reef-tang/README.md
@@ -258,11 +258,11 @@ Again, there are a few things going on here:
- They provide Java APIs that expose `OptionalParameter`,
`RequiredParameter`, `OptionalImplementation`, `RequiredImplementation` fields.
These fields tell users of the ConfigurationModule which subsystems of the
application require which configuration parameters, and allow the author of the
ConfigurationModule to use JavaDoc to document the parameters they export.
- Finally, because ConfigurationModule data structures are populated at
class load time (before the application begins to run), they can be inspected
by Tang's static analysis tools.
-These tools are provided by `org.apache.reef.tang.util.Tint`, which is
included by default in all Tang builds. As long as Tang is on the classpath,
invoking:
+These tools are provided by `tang-tint-*-shaded.jar`.
```
-java org.apache.reef.tang.util.Tint --doc tangdoc.html
+java -jar
$REEF_HOME/lang/java/reef-tang/tang-tint/target/tang-tint-*-shaded.jar --doc
tangdoc.html
```
-will perform full static analysis of all classes the class path, and emit a
nicely formatted HTML document. The documentation generated by Tint includes
cross-references between configuration options, interfaces, classes, and the
`ConfigurationModules` that use and set them.
+will perform full static analysis of all classes in the class path except REEF
classes, and emit a nicely formatted HTML document. The documentation
generated by Tint includes cross-references between configuration options,
interfaces, classes, and the `ConfigurationModules` that use and set them.
Here is the documentation for the Timer example:
http://git-wip-us.apache.org/repos/asf/reef/blob/0bd7114e/lang/java/reef-tang/doc/tangdoc.png
----------------------------------------------------------------------
diff --git a/lang/java/reef-tang/doc/tangdoc.png
b/lang/java/reef-tang/doc/tangdoc.png
index 04a09a1..4e55b7b 100644
Binary files a/lang/java/reef-tang/doc/tangdoc.png and
b/lang/java/reef-tang/doc/tangdoc.png differ
http://git-wip-us.apache.org/repos/asf/reef/blob/0bd7114e/lang/java/reef-tang/doc/tooltip.png
----------------------------------------------------------------------
diff --git a/lang/java/reef-tang/doc/tooltip.png
b/lang/java/reef-tang/doc/tooltip.png
index bd0efe1..88d6430 100644
Binary files a/lang/java/reef-tang/doc/tooltip.png and
b/lang/java/reef-tang/doc/tooltip.png differ
http://git-wip-us.apache.org/repos/asf/reef/blob/0bd7114e/lang/java/reef-tang/tang-tint/src/main/java/org/apache/reef/tang/util/Tint.java
----------------------------------------------------------------------
diff --git
a/lang/java/reef-tang/tang-tint/src/main/java/org/apache/reef/tang/util/Tint.java
b/lang/java/reef-tang/tang-tint/src/main/java/org/apache/reef/tang/util/Tint.java
index 66a2909..0f73536 100644
---
a/lang/java/reef-tang/tang-tint/src/main/java/org/apache/reef/tang/util/Tint.java
+++
b/lang/java/reef-tang/tang-tint/src/main/java/org/apache/reef/tang/util/Tint.java
@@ -318,7 +318,7 @@ public class Tint {
out.println("<html><head><title>TangDoc</title>");
out.println("<style>");
- out.println("body { font-family: 'Segoe UI', 'Comic Sans MS';
font-size:12pt; font-weight: 200; " +
+ out.println("body { font-family: 'Segoe UI', 'Helvetica';
font-size:12pt; font-weight: 200; " +
"margin: 1em; column-count: 2; }");
out.println(".package { font-size:18pt; font-weight: 500; column-span:
all; }");
// out.println(".class { break-after: never; }");
@@ -342,7 +342,7 @@ public class Tint {
final String[] tok = fullName.split("\\.");
final StringBuffer sb = new StringBuffer(tok[0]);
for (int j = 1; j < tok.length; j++) {
- if (tok[j].matches("^[A-Z].*") || j > 4) {
+ if (tok[j].matches("^[A-Z].*") || j > 5) {
break;
} else {
sb.append("." + tok[j]);
