diff options
Diffstat (limited to 'cpp/docs/api')
| -rw-r--r-- | cpp/docs/api/Makefile.am | 11 | ||||
| -rw-r--r-- | cpp/docs/api/user.doxygen (renamed from cpp/docs/api/Doxyfile) | 24 |
2 files changed, 21 insertions, 14 deletions
diff --git a/cpp/docs/api/Makefile.am b/cpp/docs/api/Makefile.am index 22a2efe8b3..7e2f2e811d 100644 --- a/cpp/docs/api/Makefile.am +++ b/cpp/docs/api/Makefile.am @@ -1,8 +1,9 @@ -html: Doxyfile doxygen.tstamp +html: user.doxygen doxygen.tstamp -# TODO aconway 2006-12-07: devdoc target to generate doc for all -# headers, with private/protected functions. +dist-hook: html + +EXTRA_DIST=html SOURCES = \ $(wildcard $(topsrcdir)/gen/*.h) \ @@ -12,7 +13,7 @@ SOURCES = \ $(wildcard $(topsrcdir)/lib/client/*.h) doxygen.tstamp: $(SOURCES) - doxygen + doxygen user.doxygen touch $@ clean-local: @@ -20,7 +21,7 @@ clean-local: HTML_TARGET_DIR=$(pkgdatadir)/api/html -install-data-local: +install-data-local: installfiles=`echo html/*`; \ if test "$$installfiles" = 'html/*'; \ then echo '-- Nothing to install' ; \ diff --git a/cpp/docs/api/Doxyfile b/cpp/docs/api/user.doxygen index 4e8afcad60..d2f47be9b4 100644 --- a/cpp/docs/api/Doxyfile +++ b/cpp/docs/api/user.doxygen @@ -1,4 +1,10 @@ -# NB: requires doxygen and graphviz - install with yum. +# ---------------------------------------------------------------- +# Doxygen settings for Qpid user documentation. +# +# Note: Only public members of classes that are part of the public API +# should be documented here. For complete developer documentation use +# the developer.doxygen configuration. +# ---------------------------------------------------------------- # Doxyfile 1.4.6 @@ -230,12 +236,12 @@ SUBGROUPING = YES # Private class members and static file members will be hidden unless # the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES -EXTRACT_ALL = YES +EXTRACT_ALL = NO # 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 # If the EXTRACT_STATIC tag is set to YES all static members of a file # will be included in the documentation. @@ -246,7 +252,7 @@ EXTRACT_STATIC = YES # 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 # 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 @@ -282,7 +288,7 @@ HIDE_FRIEND_COMPOUNDS = YES # If set to NO (the default) these blocks will be appended to the # function's detailed documentation block. -HIDE_IN_BODY_DOCS = NO +HIDE_IN_BODY_DOCS = YES # The INTERNAL_DOCS tag determines if documentation # that is typed after a \internal command is included. If the tag is set @@ -557,7 +563,7 @@ FILTER_SOURCE_FILES = NO # Note: To get rid of all source code in the generated output, make sure also # VERBATIM_HEADERS is set to NO. -SOURCE_BROWSER = YES +SOURCE_BROWSER = NO # Setting the INLINE_SOURCES tag to YES will include the body # of functions and classes directly in the documentation. @@ -723,7 +729,7 @@ ENUM_VALUES_PER_LINE = 4 # Netscape 6.0+, Internet explorer 5.0+, or Konqueror). Windows users are # probably better off using the HTML help feature. -GENERATE_TREEVIEW = NO +GENERATE_TREEVIEW = YES # If the treeview is enabled (see GENERATE_TREEVIEW) then this tag can be # used to set the initial width (in pixels) of the frame in which the tree @@ -1115,12 +1121,12 @@ GROUP_GRAPHS = YES # collaboration diagrams in a style similar to the OMG's Unified Modeling # Language. -UML_LOOK = NO +UML_LOOK = YES # If set to YES, the inheritance and collaboration graphs will show the # relations between templates and their instances. -TEMPLATE_RELATIONS = NO +TEMPLATE_RELATIONS = YES # If the ENABLE_PREPROCESSING, SEARCH_INCLUDES, INCLUDE_GRAPH, and HAVE_DOT # tags are set to YES then doxygen will generate a graph for each documented |