added package summary text and include ReadMe.md files in the API docs

koolapp · Apr 13, 2012 · 3811245 · 3811245
1 parent 97d5514
commit 3811245
Showing 1 changed file with 13 additions and 1 deletion.
diff --git a/apidoc/pom.xml b/apidoc/pom.xml
@@ -55,7 +55,7 @@
                         <source>${basedir}/../koolapp-ui/src/main/kotlin</source>
 -->
                     </sources>
-                    <title>Kool API</title>
+                    <title>KoolApp API</title>
                     <ignorePackages>
                         <ignorePackage>com</ignorePackage>
                         <ignorePackage>sun</ignorePackage>
@@ -71,6 +71,18 @@
                     </ignorePackages>
                     <sourceRootHref>https://github.com/koolapp/koolapp/tree/master</sourceRootHref>
                     <projectRootDir>${project.basedir}/..</projectRootDir>
+                    <packageDescriptionFiles>
+                        <org.koolapp.stream>${project.basedir}/../koolapp-stream/ReadMe.md</org.koolapp.stream>
+                        <org.koolapp.template>${project.basedir}/../koolapp-template/ReadMe.md</org.koolapp.template>
+                    </packageDescriptionFiles>
+                    <packageSummaryText>
+                        <org.koolapp.camel>Apache Camel extensions and integration with [Kool Streams](https://github.com/koolapp/koolapp/blob/master/koolapp-stream/ReadMe.md)</org.koolapp.camel>
+                        <org.koolapp.math>Various mathematics helper functions using [Apache Commons Math](http://commons.apache.org/math/)</org.koolapp.math>
+                        <org.koolapp.stream>[Kool Streams](https://github.com/koolapp/koolapp/blob/master/koolapp-stream/ReadMe.md) for working with events and asynchronous collections</org.koolapp.stream>
+                        <org.koolapp.template>Text processing helper classes</org.koolapp.template>
+                        <org.koolapp.template.html>[Kool Templates](https://github.com/koolapp/koolapp/blob/master/koolapp-template/ReadMe.md) a HTML5 template engine</org.koolapp.template.html>
+                    </packageSummaryText>
+
                 </configuration>
 
                 <executions>