From ad3e227c6f0a8d45bb092c45111f70f9e23d4b3e Mon Sep 17 00:00:00 2001
From: Jonathan Robie <jonathan@apache.org>
Date: Thu, 29 Jul 2010 12:58:38 +0000
Subject: Added overview page, designed to list starting points for developers.

Currently lists starting points for the broker. Need similar sections for client, management, etc.


git-svn-id: https://svn.apache.org/repos/asf/qpid/trunk/qpid@980429 13f79535-47bb-0310-9956-ffa450edef68
---
 cpp/docs/api/developer.doxygen.in         |  3 +-
 cpp/docs/api/doxygen_developer_mainpage.h | 60 +++++++++++++++++++++++++++++++
 2 files changed, 62 insertions(+), 1 deletion(-)
 create mode 100644 cpp/docs/api/doxygen_developer_mainpage.h

(limited to 'cpp/docs')

diff --git a/cpp/docs/api/developer.doxygen.in b/cpp/docs/api/developer.doxygen.in
index 96d67c027f..7765a8e3d3 100644
--- a/cpp/docs/api/developer.doxygen.in
+++ b/cpp/docs/api/developer.doxygen.in
@@ -464,7 +464,7 @@ WARN_LOGFILE           = doxygen.log
 # directories like "/usr/src/myproject". Separate the files or directories 
 # with spaces.
 
-INPUT      		= @top_srcdir@/include @top_srcdir@/src @top_builddir@/include @top_builddir@/src
+INPUT = @top_srcdir@/docs/api/doxygen_developer_mainpage.h  @top_srcdir@/include @top_srcdir@/src @top_builddir@/include @top_builddir@/src
 
 # If the value of the INPUT tag contains directories, you can use the 
 # FILE_PATTERNS tag to specify one or more wildcard pattern (like *.cpp 
@@ -994,6 +994,7 @@ SEARCH_INCLUDES        = YES
 
 INCLUDE_PATH           = 
 
+
 # You can use the INCLUDE_FILE_PATTERNS tag to specify one or more wildcard 
 # patterns (like *.h and *.hpp) to filter out the header-files in the 
 # directories. If left blank, the patterns specified with FILE_PATTERNS will 
diff --git a/cpp/docs/api/doxygen_developer_mainpage.h b/cpp/docs/api/doxygen_developer_mainpage.h
new file mode 100644
index 0000000000..dc393725f5
--- /dev/null
+++ b/cpp/docs/api/doxygen_developer_mainpage.h
@@ -0,0 +1,60 @@
+/*
+ * 
+ * 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.
+ * 
+ */
+
+// This header file is just for doxygen documentation purposes.
+
+/** \mainpage Qpid Developer Documentation
+ *
+ * <h2>Starting Points: Broker</h2>
+ *  
+ * <p>Message flow generally starts from the following methods:</p>
+ *
+ * <ul>
+ *   <li><p>qpid::broker::Connection::received() - handles incoming decoded frames from the IO layer</p></li>
+ *   <li><p>qpid::broker::Connection::doOutput() - sends messages to eligible consumers</p></li>
+ * </ul>
+ *
+ * <p>The following classes are useful starting points for
+ * understanding the structure of the broker:</p>
+ *
+ * <p>IO:</p>
+ * <ul><li><p>qpid::sys::Poller</p></li></ul>
+ * 
+ * <p>Broker - per Client</p>
+ * <ul>
+ *   <li><p>qpid::broker::Connection</p></li>
+ *   <li><p>qpid::broker::SemanticState</p></li>
+ *   <li><p>qpid::broker::SemanticState::ConsumerImpl</p></li>
+ * </ul>
+ *
+ * <p>Broker - shared among all clients</p>
+ *
+ * <ul>
+ *   <li><p>qpid::broker::Queue</p></li>
+ *   <li><p>qpid::broker::Exchange</p></li>
+ *   <li><p>Subclasses of Queue and Exchange</p></li>
+ * </ul>
+ *
+ */
+
+
+
+
-- 
cgit v1.2.1