dorkbox/MessageBus
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

added javadoc to github pages

Browse Source
This commit is contained in:
bennidi 2014-01-10 18:05:25 +01:00
parent fe696c2f95
commit 9ee3f11578
2 changed files with 35 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
README.md
View File

@ -8,8 +8,8 @@ The performance win of this design is illustrated in <a href="http://codeblock.e
The benchmarking code can be found <a href="https://github.com/bennidi/eventbus-performance" target="_blank">here</a>
Read this documentation to get an overview of MBassadors features. There is also some documentation in the Wiki - although admittedly
not enough to make a developer happy (work is in progress). But usage of publish subscribe pattern at its core is pretty straight forward and the basic
use cases are very easy to understand and implement.
not enough to make a developer happy (work is in progress). Additionally, you can browse the javadocs.
[javadoc](http://bennidi.github.io/mbassador/)
The current version is 1.1.9 and it is available from the Maven Central Repository. See the release notes for more details.

33
pom.xml
View File

@ -196,6 +196,39 @@
</executions>
</plugin>
<!--
These two plugins take care of building and publishing the javadoc, using
mvn clean javadoc:javadoc scm-publish:publish-scm
-->
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>2.9.1</version>
<configuration>
<aggregate>true</aggregate>
<show>public</show>
<nohelp>true</nohelp>
<header>mbassador, ${project.version}</header>
<footer>mbassador, ${project.version}</footer>
<doctitle>mbassador, ${project.version}</doctitle>
<links>
<link>http://static.springsource.org/spring/docs/3.0.x/javadoc-api/</link>
</links>
</configuration>
</plugin>
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-scm-publish-plugin</artifactId>
<version>1.0-beta-2</version>
<configuration>
<checkoutDirectory>${project.build.directory}/scmpublish</checkoutDirectory>
<checkinComment>Publishing javadoc for ${project.artifactId}:${project.version}</checkinComment>
<content>${project.reporting.outputDirectory}/apidocs</content>
<skipDeletedFiles>true</skipDeletedFiles>
<pubScmUrl>scm:git:git@github.com:bennidi/mbassador.git</pubScmUrl>
<scmBranch>gh-pages</scmBranch> <!-- branch with static site -->
</configuration>
</plugin>
</plugins>
</build>