commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From er...@apache.org
Subject [1/3] commons-rng git commit: Module dedicated web page.
Date Fri, 04 Nov 2016 12:08:04 GMT
Repository: commons-rng
Updated Branches:
  refs/heads/multimodule 950f8b7b9 -> 1068c58bd


Module dedicated web page.


Project: http://git-wip-us.apache.org/repos/asf/commons-rng/repo
Commit: http://git-wip-us.apache.org/repos/asf/commons-rng/commit/568e74be
Tree: http://git-wip-us.apache.org/repos/asf/commons-rng/tree/568e74be
Diff: http://git-wip-us.apache.org/repos/asf/commons-rng/diff/568e74be

Branch: refs/heads/multimodule
Commit: 568e74be47d8b5ee6db3af358ca3384c04d092cd
Parents: 950f8b7
Author: Gilles <erans@apache.org>
Authored: Fri Nov 4 13:06:28 2016 +0100
Committer: Gilles <erans@apache.org>
Committed: Fri Nov 4 13:06:28 2016 +0100

----------------------------------------------------------------------
 commons-rng-client-api/src/site/site.xml       | 40 ++++++++++++++
 commons-rng-client-api/src/site/xdoc/index.xml | 58 +++++++++++++++++++++
 2 files changed, 98 insertions(+)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/commons-rng/blob/568e74be/commons-rng-client-api/src/site/site.xml
----------------------------------------------------------------------
diff --git a/commons-rng-client-api/src/site/site.xml b/commons-rng-client-api/src/site/site.xml
new file mode 100644
index 0000000..7fe52b2
--- /dev/null
+++ b/commons-rng-client-api/src/site/site.xml
@@ -0,0 +1,40 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements.  See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ (the "License"); you may not use this file except in compliance with
+ the License.  You may obtain a copy of the License at
+
+      http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+-->
+<project name="RNG">
+  <bannerRight>
+    <name>Apache Commons RNG</name>
+    <src>/images/commons_rng.small.png</src>
+    <href>/index.html</href>
+  </bannerRight>
+
+  <body>
+    <menu name="RNG Client API">
+      <item name="Overview" href="index.html"/>
+      <item name="Latest API docs (development)"
+            href="apidocs/index.html"/>
+      <item name="Javadoc (1.0 release)"
+            href="http://commons.apache.org/rng/client-api/javadocs/api-1.0/index.html"/>
+    </menu>
+    
+    <head>
+      <script type="text/javascript" src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML">
+      </script>
+    </head>
+
+  </body>
+</project>

http://git-wip-us.apache.org/repos/asf/commons-rng/blob/568e74be/commons-rng-client-api/src/site/xdoc/index.xml
----------------------------------------------------------------------
diff --git a/commons-rng-client-api/src/site/xdoc/index.xml b/commons-rng-client-api/src/site/xdoc/index.xml
new file mode 100644
index 0000000..49bb584
--- /dev/null
+++ b/commons-rng-client-api/src/site/xdoc/index.xml
@@ -0,0 +1,58 @@
+<?xml version="1.0"?>
+
+<!--
+   Licensed to the Apache Software Foundation (ASF) under one or more
+  contributor license agreements.  See the NOTICE file distributed with
+  this work for additional information regarding copyright ownership.
+  The ASF licenses this file to You under the Apache License, Version 2.0
+  (the "License"); you may not use this file except in compliance with
+  the License.  You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.
+  -->
+  
+<document>
+
+  <properties>
+    <title>Commons RNG Client API</title>
+  </properties>
+
+  <body>
+
+    <section name="Apache Commons RNG: Random Numbers Generators" href="summary">
+      <p>
+        Commons RNG provides implementations of pseudo-random numbers generators that are
+        either faster or of higher quality (and sometimes both) than <code>java.util.Random</code>.
+      </p>
+
+      <p>
+        The "client API" module contains the code that defines the API for client code.
+      </p>
+
+      <p>
+        Example:
+
+<source>import org.apache.commons.rng.UniformRandomProvider;
+
+public class Dice {
+    public int roll(UniformRandomProvider rng) {
+        return 1 + rng.nextInt(6);
+    }
+}
+</source>
+      </p>
+
+      <p>
+        Browse the <a href="apidocs/index.html">Javadoc</a> to see the complete
API.
+      </p>
+    </section>
+
+  </body>
+
+</document>


Mime
View raw message