Permalink
Browse files

Update the READMe with some Java information. Generate some javadocs

  • Loading branch information...
1 parent fdf8651 commit ad733879468eda3545fe131b732398ca7067685b @mzsanford committed May 1, 2012
View
34 README
@@ -126,6 +126,40 @@ Both the `detectSync` and `detect` methods take an option second parameter that
* `skipWeakMatches` (`false`): Include weak matches in the results
+
+## Java
+
+## Ruby
+
+### Prerequisites
+
+The `libcld` C++ library must be installed (see above)
+
+### Installing
+
+ # Maven repository information in the future
+ $ git clone http://github.com/mzsanford/cld.git
+ $ cd cld/ports/java
+ # mvn test (optional)
+ $ mvn install
+
+### Example
+
+ CompactLanguageDetector compactLanguageDetector = new CompactLanguageDetector();
+ LanguageDetectionResult result = compactLanguageDetector.detect("This is my sample text");
+ if (result.isReliable()) {
+ // getProbableLocale returns a java.util.Locale
+ System.out.println("Pretty sure that's " + result.getProbableLocale().getDisplayName());
+ } else {
+ for (LanguageDetectionCandidate candidate : result.getCandidates()) {
+ System.out.println("Maybe it's " + candidate.getLocale().getDisplayName());
+ }
+ }
+
+### Documentation
+
+Full Javadocs are at [http://mzsanford.github.com/cld/ports/java/doc/apidocs](http://mzsanford.github.com/cld/ports/java/doc/apidocs).
+
## Python
### Prerequisites
View
@@ -126,6 +126,40 @@ Both the `detectSync` and `detect` methods take an option second parameter that
* `skipWeakMatches` (`false`): Include weak matches in the results
+
+## Java
+
+## Ruby
+
+### Prerequisites
+
+The `libcld` C++ library must be installed (see above)
+
+### Installing
+
+ # Maven repository information in the future
+ $ git clone http://github.com/mzsanford/cld.git
+ $ cd cld/ports/java
+ # mvn test (optional)
+ $ mvn install
+
+### Example
+
+ CompactLanguageDetector compactLanguageDetector = new CompactLanguageDetector();
+ LanguageDetectionResult result = compactLanguageDetector.detect("This is my sample text");
+ if (result.isReliable()) {
+ // getProbableLocale returns a java.util.Locale
+ System.out.println("Pretty sure that's " + result.getProbableLocale().getDisplayName());
+ } else {
+ for (LanguageDetectionCandidate candidate : result.getCandidates()) {
+ System.out.println("Maybe it's " + candidate.getLocale().getDisplayName());
+ }
+ }
+
+### Documentation
+
+Full Javadocs are at [http://mzsanford.github.com/cld/ports/java/doc/apidocs](http://mzsanford.github.com/cld/ports/java/doc/apidocs).
+
## Python
### Prerequisites
@@ -0,0 +1,36 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc (build 1.6.0_29) on Tue May 01 10:32:35 PDT 2012 -->
+<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<TITLE>
+All Classes (Compact Language Detector - Java 1.0-SNAPSHOT API)
+</TITLE>
+
+<META NAME="date" CONTENT="2012-05-01">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
+
+
+</HEAD>
+
+<BODY BGCOLOR="white">
+<FONT size="+1" CLASS="FrameHeadingFont">
+<B>All Classes</B></FONT>
+<BR>
+
+<TABLE BORDER="0" WIDTH="100%" SUMMARY="">
+<TR>
+<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="com/mzsanford/cld/CompactLanguageDetector.html" title="class in com.mzsanford.cld" target="classFrame">CompactLanguageDetector</A>
+<BR>
+<A HREF="com/mzsanford/cld/LanguageDetectionCandidate.html" title="class in com.mzsanford.cld" target="classFrame">LanguageDetectionCandidate</A>
+<BR>
+<A HREF="com/mzsanford/cld/LanguageDetectionResult.html" title="class in com.mzsanford.cld" target="classFrame">LanguageDetectionResult</A>
+<BR>
+</FONT></TD>
+</TR>
+</TABLE>
+
+</BODY>
+</HTML>
@@ -0,0 +1,36 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!--NewPage-->
+<HTML>
+<HEAD>
+<!-- Generated by javadoc (build 1.6.0_29) on Tue May 01 10:32:35 PDT 2012 -->
+<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
+<TITLE>
+All Classes (Compact Language Detector - Java 1.0-SNAPSHOT API)
+</TITLE>
+
+<META NAME="date" CONTENT="2012-05-01">
+
+<LINK REL ="stylesheet" TYPE="text/css" HREF="stylesheet.css" TITLE="Style">
+
+
+</HEAD>
+
+<BODY BGCOLOR="white">
+<FONT size="+1" CLASS="FrameHeadingFont">
+<B>All Classes</B></FONT>
+<BR>
+
+<TABLE BORDER="0" WIDTH="100%" SUMMARY="">
+<TR>
+<TD NOWRAP><FONT CLASS="FrameItemFont"><A HREF="com/mzsanford/cld/CompactLanguageDetector.html" title="class in com.mzsanford.cld">CompactLanguageDetector</A>
+<BR>
+<A HREF="com/mzsanford/cld/LanguageDetectionCandidate.html" title="class in com.mzsanford.cld">LanguageDetectionCandidate</A>
+<BR>
+<A HREF="com/mzsanford/cld/LanguageDetectionResult.html" title="class in com.mzsanford.cld">LanguageDetectionResult</A>
+<BR>
+</FONT></TD>
+</TR>
+</TABLE>
+
+</BODY>
+</HTML>
Oops, something went wrong.

0 comments on commit ad73387

Please sign in to comment.