Author: eric Date: Tue Sep 6 20:27:49 2011 New Revision: 1165827 URL: http://svn.apache.org/viewvc?rev=1165827&view=rev Log: Simple fix on the mailbox web site documentation - work in progress
Added: james/mailbox/trunk/src/site/xdoc/mailbox-guice.html james/mailbox/trunk/src/site/xdoc/mailbox-spring.html Modified: james/mailbox/trunk/src/site/xdoc/mailbox-api.xml james/mailbox/trunk/src/site/xdoc/mailbox-hbase.xml james/mailbox/trunk/src/site/xdoc/mailbox-jcr.xml james/mailbox/trunk/src/site/xdoc/mailbox-jpa.xml james/mailbox/trunk/src/site/xdoc/mailbox-maildir.xml james/mailbox/trunk/src/site/xdoc/mailbox-memory.xml james/mailbox/trunk/src/site/xdoc/mailbox-store.xml james/mailbox/trunk/src/site/xdoc/mailbox-tool.xml Modified: james/mailbox/trunk/src/site/xdoc/mailbox-api.xml URL: http://svn.apache.org/viewvc/james/mailbox/trunk/src/site/xdoc/mailbox-api.xml?rev=1165827&r1=1165826&r2=1165827&view=diff ============================================================================== --- james/mailbox/trunk/src/site/xdoc/mailbox-api.xml (original) +++ james/mailbox/trunk/src/site/xdoc/mailbox-api.xml Tue Sep 6 20:27:49 2011 @@ -25,7 +25,7 @@ <body> - <section name="Responsibility"> + <section name="Mailbox API Responsibility"> <p>This module contains the interfaces and exceptions to be used by the mailbox clients. It represents the "external view" of the mailbox library client.</p> @@ -49,23 +49,35 @@ <subsection name="Mailbox Manager"> <p>The Mailbox Manager is responsible for session creation, operations on mailbox (create, delete, search) and to return a Message Manager. It also allows to copy and list messages.</p> +<!-- +Image is no more in line with trunk <p><img src="images/uml/org-apache-james-mailbox-api-mailboxmanager.png"/></p> +--> </subsection> <subsection name="Message Manager"> <p>The Message Manager is responsible to create, delete message and its associated metadata (the uid and the flags).</p> +<!-- +Image is no more in line with trunk <p><img src="images/uml/org-apache-james-mailbox-api-messagemanager.png"/></p> + --> </subsection> <subsection name="Subscription Manager"> <p>The Subscription Manager is responsible for the (un)subscription between a user and a mailbox.</p> +<!-- +Image is no more in line with trunk <p><img src="images/uml/org-apache-james-mailbox-api-subscriptionmanager.png"/></p> +--> </subsection> </section> <section name="Other Interfaces and Classes"> +<!-- +Image is no more in line with trunk <p><img src="images/uml/org-apache-james-mailbox-api-msc.png"/></p> +--> </section> </body> Added: james/mailbox/trunk/src/site/xdoc/mailbox-guice.html URL: http://svn.apache.org/viewvc/james/mailbox/trunk/src/site/xdoc/mailbox-guice.html?rev=1165827&view=auto ============================================================================== --- james/mailbox/trunk/src/site/xdoc/mailbox-guice.html (added) +++ james/mailbox/trunk/src/site/xdoc/mailbox-guice.html Tue Sep 6 20:27:49 2011 @@ -0,0 +1,31 @@ +<?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>Mailbox Guice</title> + </properties> + +<body> + + +</body> + +</document> Modified: james/mailbox/trunk/src/site/xdoc/mailbox-hbase.xml URL: http://svn.apache.org/viewvc/james/mailbox/trunk/src/site/xdoc/mailbox-hbase.xml?rev=1165827&r1=1165826&r2=1165827&view=diff ============================================================================== --- james/mailbox/trunk/src/site/xdoc/mailbox-hbase.xml (original) +++ james/mailbox/trunk/src/site/xdoc/mailbox-hbase.xml Tue Sep 6 20:27:49 2011 @@ -25,10 +25,10 @@ <body> - <section name="Responsibility"> + <section name="Mailbox HBase Responsibility"> </section> - <section name="Classes"> + <section name="Mailbox HBase Classes"> <subsection name="Managers"> </subsection> Modified: james/mailbox/trunk/src/site/xdoc/mailbox-jcr.xml URL: http://svn.apache.org/viewvc/james/mailbox/trunk/src/site/xdoc/mailbox-jcr.xml?rev=1165827&r1=1165826&r2=1165827&view=diff ============================================================================== --- james/mailbox/trunk/src/site/xdoc/mailbox-jcr.xml (original) +++ james/mailbox/trunk/src/site/xdoc/mailbox-jcr.xml Tue Sep 6 20:27:49 2011 @@ -25,10 +25,10 @@ <body> - <section name="Responsibility"> + <section name="Maibox JCR Responsibility"> </section> - <section name="Classes"> + <section name="Mailbox JCR Classes"> </section> </body> Modified: james/mailbox/trunk/src/site/xdoc/mailbox-jpa.xml URL: http://svn.apache.org/viewvc/james/mailbox/trunk/src/site/xdoc/mailbox-jpa.xml?rev=1165827&r1=1165826&r2=1165827&view=diff ============================================================================== --- james/mailbox/trunk/src/site/xdoc/mailbox-jpa.xml (original) +++ james/mailbox/trunk/src/site/xdoc/mailbox-jpa.xml Tue Sep 6 20:27:49 2011 @@ -25,13 +25,16 @@ <body> - <section name="Responsibility"> + <section name="Mailbox JPA Responsibility"> </section> - <section name="Classes"> + <section name="Mailbox JPA Classes"> <subsection name="Managers"> +<!-- +Image is no more in line with trunk <p><img src="images/uml/org-apache-james-mailbox-jpa-managers.png"/></p> +--> </subsection> </section> Modified: james/mailbox/trunk/src/site/xdoc/mailbox-maildir.xml URL: http://svn.apache.org/viewvc/james/mailbox/trunk/src/site/xdoc/mailbox-maildir.xml?rev=1165827&r1=1165826&r2=1165827&view=diff ============================================================================== --- james/mailbox/trunk/src/site/xdoc/mailbox-maildir.xml (original) +++ james/mailbox/trunk/src/site/xdoc/mailbox-maildir.xml Tue Sep 6 20:27:49 2011 @@ -25,13 +25,16 @@ <body> - <section name="Responsibility"> + <section name="Mailbox Maildir Responsibility"> </section> - <section name="Classes"> + <section name="Mailbox Maildir Classes"> <subsection name="Managers"> +<!-- +Image is no more in line with trunk <p><img src="images/uml/org-apache-james-mailbox-maildir-managers.png"/></p> +--> </subsection> </section> Modified: james/mailbox/trunk/src/site/xdoc/mailbox-memory.xml URL: http://svn.apache.org/viewvc/james/mailbox/trunk/src/site/xdoc/mailbox-memory.xml?rev=1165827&r1=1165826&r2=1165827&view=diff ============================================================================== --- james/mailbox/trunk/src/site/xdoc/mailbox-memory.xml (original) +++ james/mailbox/trunk/src/site/xdoc/mailbox-memory.xml Tue Sep 6 20:27:49 2011 @@ -25,13 +25,16 @@ <body> - <section name="Responsibility"> + <section name="Mailbox Memory Responsibility"> </section> - <section name="Classes"> + <section name="Mailbox Memory Classes"> <subsection name="Managers"> +<!-- +Image is no more in line with trunk <p><img src="images/uml/org-apache-james-mailbox-memory-managers.png"/></p> +--> </subsection> </section> Added: james/mailbox/trunk/src/site/xdoc/mailbox-spring.html URL: http://svn.apache.org/viewvc/james/mailbox/trunk/src/site/xdoc/mailbox-spring.html?rev=1165827&view=auto ============================================================================== --- james/mailbox/trunk/src/site/xdoc/mailbox-spring.html (added) +++ james/mailbox/trunk/src/site/xdoc/mailbox-spring.html Tue Sep 6 20:27:49 2011 @@ -0,0 +1,31 @@ +<?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>Mailbox Spring</title> + </properties> + +<body> + + +</body> + +</document> Modified: james/mailbox/trunk/src/site/xdoc/mailbox-store.xml URL: http://svn.apache.org/viewvc/james/mailbox/trunk/src/site/xdoc/mailbox-store.xml?rev=1165827&r1=1165826&r2=1165827&view=diff ============================================================================== --- james/mailbox/trunk/src/site/xdoc/mailbox-store.xml (original) +++ james/mailbox/trunk/src/site/xdoc/mailbox-store.xml Tue Sep 6 20:27:49 2011 @@ -25,7 +25,7 @@ <body> - <section name="Responsibility"> + <section name="Mailbox Store Responsibility"> <p>The Mailbox Store is responsible for all "common/util" implementations that can be used by the various Mailbox implementations.</p> </section> @@ -34,29 +34,41 @@ <p>The main classes are the Mailbox and the Message. A Message contains a list of Property and a list of Header. A Subscription has a mailbox and a user attribute.</p> +<!-- +Image is no more in line with trunk <p><img src="images/uml/org-apache-james-mailbox-store-model.png"/></p> +--> </section> - <section name="Managers"> + <section name="Mailbox Store Managers"> <subsection name="Store Mailbox Manager"> <p>All public and protected methods that can be used by a Mailbox Manager implementations.</p> <p>You need to instanciate the StoreMailboxManager with a mailboxSessionMapperFactory, an authenticator, a uidProvider and a mailboxPathlocker.</p> +<!-- +Image is no more in line with trunk <p><img src="images/uml/org-apache-james-mailbox-store-mailboxmanager.png"/></p> +--> </subsection> <subsection name="Store Message Manager"> <p>All public and protected methods that can be used by a Message Manager implementations.</p> <p>You need to instanciate the StoreMessageManager with a messageSessionMapperFactory, a uidProvider, a mailboxEventDispatcher and a mailbox.</p> +<!-- +Image is no more in line with trunk <p><img src="images/uml/org-apache-james-mailbox-store-messagemanager.png"/></p> +--> </subsection> <subsection name="Store Subscription Manager"> <p>All public and protected methods that can be used by a Subscription Manager implementations.</p> <p>You need to instanciate the StoreSubscriptionManager with a subscriptionSessionMapperFactory.</p> +<!-- +Image is no more in line with trunk <p><img src="images/uml/org-apache-james-mailbox-store-subscriptionmanager.png"/></p> +--> </subsection> </section> Modified: james/mailbox/trunk/src/site/xdoc/mailbox-tool.xml URL: http://svn.apache.org/viewvc/james/mailbox/trunk/src/site/xdoc/mailbox-tool.xml?rev=1165827&r1=1165826&r2=1165827&view=diff ============================================================================== --- james/mailbox/trunk/src/site/xdoc/mailbox-tool.xml (original) +++ james/mailbox/trunk/src/site/xdoc/mailbox-tool.xml Tue Sep 6 20:27:49 2011 @@ -20,15 +20,15 @@ <document> <properties> - <title>Mailbox API</title> + <title>Mailbox Tool</title> </properties> <body> - <section name="Responsibility"> + <section name="Mailbox Tool Responsibility"> </section> - <section name="Classes"> + <section name="Mailbox Tool Classes"> </section> </body> --------------------------------------------------------------------- To unsubscribe, e-mail: server-dev-unsubscr...@james.apache.org For additional commands, e-mail: server-dev-h...@james.apache.org