Author: jonathan
Date: Mon Nov 17 09:17:38 2008
New Revision: 718278
URL: http://svn.apache.org/viewvc?rev=718278&view=rev
Log:
Modified user.doxygen.in to incorporate main page documentation.
Modified:
incubator/qpid/trunk/qpid/cpp/docs/api/developer.doxygen.in
incubator/qpid/trunk/qpid/cpp/docs/api/user.doxygen.in
Modified: incubator/qpid/trunk/qpid/cpp/docs/api/developer.doxygen.in
URL:
http://svn.apache.org/viewvc/incubator/qpid/trunk/qpid/cpp/docs/api/developer.doxygen.in?rev=718278&r1=718277&r2=718278&view=diff
==============================================================================
--- incubator/qpid/trunk/qpid/cpp/docs/api/developer.doxygen.in (original)
+++ incubator/qpid/trunk/qpid/cpp/docs/api/developer.doxygen.in Mon Nov 17
09:17:38 2008
@@ -105,7 +105,7 @@
# members were ordinary class members. Constructors, destructors and
assignment
# operators of the base classes will not be shown.
-INLINE_INHERITED_MEMB = NO
+INLINE_INHERITED_MEMB = YES # was NO - jwr
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
# path before files name in the file list and in the header files. If set
@@ -120,7 +120,7 @@
# If left blank the directory from which doxygen is run is used as the
# path to strip.
-STRIP_FROM_PATH =
+STRIP_FROM_PATH = /home/jrobie/project/qpid/
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
# the path mentioned in the documentation of a class, which tells
@@ -151,14 +151,14 @@
# The new default is to treat a multi-line C++ comment block as a detailed
# description. Set this tag to YES if you prefer the old behaviour instead.
-MULTILINE_CPP_IS_BRIEF = NO
+MULTILINE_CPP_IS_BRIEF = YES # was NO
# If the DETAILS_AT_TOP tag is set to YES then Doxygen
# will output the detailed description near the top, like JavaDoc.
# If set to NO, the detailed description appears after the member
# documentation.
-DETAILS_AT_TOP = NO
+DETAILS_AT_TOP = YES # was NO
# If the INHERIT_DOCS tag is set to YES (the default) then an undocumented
# member inherits the documentation from any documented member that it
@@ -238,7 +238,7 @@
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
# will be included in the documentation.
-EXTRACT_PRIVATE = YES
+EXTRACT_PRIVATE = NO # was YES
# If the EXTRACT_STATIC tag is set to YES all static members of a file
# will be included in the documentation.
@@ -249,14 +249,14 @@
# defined locally in source files will be included in the documentation.
# If set to NO only classes defined in header files are included.
-EXTRACT_LOCAL_CLASSES = YES
+EXTRACT_LOCAL_CLASSES = NO # was YES
# This flag is only useful for Objective-C code. When set to YES local
# methods, which are defined in the implementation section but not in
# the interface are included in the documentation.
# If set to NO (the default) only methods in the interface are included.
-EXTRACT_LOCAL_METHODS = YES
+EXTRACT_LOCAL_METHODS = NO # was YES
# If the HIDE_UNDOC_MEMBERS tag is set to YES, Doxygen will hide all
# undocumented members of documented classes, files or namespaces.
@@ -411,7 +411,7 @@
# The QUIET tag can be used to turn on/off the messages that are generated
# by doxygen. Possible values are YES and NO. If left blank NO is used.
-QUIET = YES
+QUIET = NO
# The WARNINGS tag can be used to turn on/off the warning messages that are
# generated by doxygen. Possible values are YES and NO. If left blank
Modified: incubator/qpid/trunk/qpid/cpp/docs/api/user.doxygen.in
URL:
http://svn.apache.org/viewvc/incubator/qpid/trunk/qpid/cpp/docs/api/user.doxygen.in?rev=718278&r1=718277&r2=718278&view=diff
==============================================================================
--- incubator/qpid/trunk/qpid/cpp/docs/api/user.doxygen.in (original)
+++ incubator/qpid/trunk/qpid/cpp/docs/api/user.doxygen.in Mon Nov 17 09:17:38
2008
@@ -98,7 +98,7 @@
# members were ordinary class members. Constructors, destructors and
assignment
# operators of the base classes will not be shown.
-INLINE_INHERITED_MEMB = NO
+INLINE_INHERITED_MEMB = YES
# If the FULL_PATH_NAMES tag is set to YES then Doxygen will prepend the full
# path before files name in the file list and in the header files. If set
@@ -113,7 +113,7 @@
# If left blank the directory from which doxygen is run is used as the
# path to strip.
-STRIP_FROM_PATH =
+STRIP_FROM_PATH = ../../src/ ../..
# The STRIP_FROM_INC_PATH tag can be used to strip a user-defined part of
# the path mentioned in the documentation of a class, which tells
@@ -226,7 +226,7 @@
# Private class members and static file members will be hidden unless
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
-EXTRACT_ALL = NO
+EXTRACT_ALL = YES
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
# will be included in the documentation.
@@ -404,8 +404,7 @@
# The QUIET tag can be used to turn on/off the messages that are generated
# by doxygen. Possible values are YES and NO. If left blank NO is used.
-QUIET = YES
-
+QUIET = NO
# The WARNINGS tag can be used to turn on/off the warning messages that are
# generated by doxygen. Possible values are YES and NO. If left blank
# NO is used.
@@ -457,7 +456,9 @@
# directories like "/usr/src/myproject". Separate the files or directories
# with spaces.
-INPUT = @top_srcdir@/src/qpid @top_builddir@/src/gen/qpid
+# INPUT = ../../src/qpid ../../src/gen/qpid
+INPUT = ../../src/qpid/client ../../src/qpid/framing
../../src/gen/qpid/client .
+
# 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
@@ -471,7 +472,7 @@
# should be searched for input files as well. Possible values are YES and NO.
# If left blank NO is used.
-RECURSIVE = YES
+RECURSIVE = NO
# The EXCLUDE tag can be used to specify files and/or directories that should
# excluded from the INPUT source files. This way you can easily exclude a
@@ -491,7 +492,7 @@
# against the file with absolute path, so to exclude all test directories
# for example use the pattern */test/*
-EXCLUDE_PATTERNS =
+EXCLUDE_PATTERNS = *Session_99_0*
# The EXAMPLE_PATH tag can be used to specify one or more files or
# directories that contain example code fragments that are included (see
@@ -600,7 +601,7 @@
# of all compounds will be generated. Enable this if the project
# contains a lot of classes, structs, unions or interfaces.
-ALPHABETICAL_INDEX = NO
+ALPHABETICAL_INDEX = YES
# If the alphabetical index is enabled (see ALPHABETICAL_INDEX) then
# the COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns
@@ -640,13 +641,13 @@
# each generated HTML page. If it is left blank doxygen will generate a
# standard header.
-HTML_HEADER =
+HTML_HEADER = ./header.html
# The HTML_FOOTER tag can be used to specify a personal HTML footer for
# each generated HTML page. If it is left blank doxygen will generate a
# standard footer.
-HTML_FOOTER =
+HTML_FOOTER = ./footer.html
# The HTML_STYLESHEET tag can be used to specify a user-defined cascading
# style sheet that is used by each HTML page. It can be used to
@@ -968,7 +969,7 @@
# compilation will be performed. Macro expansion can be done in a controlled
# way by setting EXPAND_ONLY_PREDEF to YES.
-MACRO_EXPANSION = NO
+MACRO_EXPANSION = YES
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES
# then the macro expansion is limited to the macros specified with the
@@ -1009,7 +1010,7 @@
# The macro definition that is found in the sources will be used.
# Use the PREDEFINED tag if you want to use a different macro definition.
-EXPAND_AS_DEFINED =
+EXPAND_AS_DEFINED = BOOST_PARAMETER_MEMFUN
# If the SKIP_FUNCTION_MACROS tag is set to YES (the default) then
# doxygen's preprocessor will remove all function-like macros that are alone
@@ -1215,4 +1216,4 @@
# The SEARCHENGINE tag specifies whether or not a search engine should be
# used. If set to NO the values of all tags below this one will be ignored.
-SEARCHENGINE = YES
+SEARCHENGINE = NO
