You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@qpid.apache.org by ac...@apache.org on 2015/01/20 23:02:08 UTC
svn commit: r1653384 - in /qpid/dispatch/branches/0.3/doc: CMakeLists.txt
api/CMakeLists.txt api/doxygen.in book/schema_md.py
Author: aconway
Date: Tue Jan 20 22:02:07 2015
New Revision: 1653384
URL: http://svn.apache.org/r1653384
Log:
NO-JIRA: Improvements to API doc generation.
Modified:
qpid/dispatch/branches/0.3/doc/CMakeLists.txt
qpid/dispatch/branches/0.3/doc/api/CMakeLists.txt
qpid/dispatch/branches/0.3/doc/api/doxygen.in
qpid/dispatch/branches/0.3/doc/book/schema_md.py
Modified: qpid/dispatch/branches/0.3/doc/CMakeLists.txt
URL: http://svn.apache.org/viewvc/qpid/dispatch/branches/0.3/doc/CMakeLists.txt?rev=1653384&r1=1653383&r2=1653384&view=diff
==============================================================================
--- qpid/dispatch/branches/0.3/doc/CMakeLists.txt (original)
+++ qpid/dispatch/branches/0.3/doc/CMakeLists.txt Tue Jan 20 22:02:07 2015
@@ -40,8 +40,9 @@ macro(doc_tool tool use var what)
endmacro()
doc_tool(pandoc USE_PANDOC PANDOC "HTML and man page documentation")
-doc_tool(doxygen USE_DOXYGEN DOXYGEN_FOUND "API documentation")
doc_tool(pdflatex USE_PDFLATEX PDFLATEX "PDF documentation (also requires pandoc)")
+doc_tool(doxygen USE_DOXYGEN DOXYGEN_FOUND "API documentation")
+doc_tool(dot USE_DOT DOT "Generate diagrams in API documentation (also requires doxygen)")
add_subdirectory(api)
add_subdirectory(man)
Modified: qpid/dispatch/branches/0.3/doc/api/CMakeLists.txt
URL: http://svn.apache.org/viewvc/qpid/dispatch/branches/0.3/doc/api/CMakeLists.txt?rev=1653384&r1=1653383&r2=1653384&view=diff
==============================================================================
--- qpid/dispatch/branches/0.3/doc/api/CMakeLists.txt (original)
+++ qpid/dispatch/branches/0.3/doc/api/CMakeLists.txt Tue Jan 20 22:02:07 2015
@@ -20,14 +20,15 @@
if(USE_DOXYGEN)
# Create doxygen configuration files.
- function(configure_doxygen DOXYGEN_OUTPUT_DIRECTORY DOXYGEN_INPUT DOXYGEN_MORE)
+ function(configure_doxygen HTML_OUTPUT INPUT MORE_CONFIG)
configure_file(
${CMAKE_CURRENT_SOURCE_DIR}/doxygen.in
- ${CMAKE_CURRENT_BINARY_DIR}/${DOXYGEN_OUTPUT_DIRECTORY}.doxygen)
+ ${CMAKE_CURRENT_BINARY_DIR}/${HTML_OUTPUT}.doxygen)
endfunction(configure_doxygen)
+
configure_doxygen(user "${CMAKE_SOURCE_DIR}/include" "")
configure_doxygen(dev "${CMAKE_SOURCE_DIR}/include ${CMAKE_SOURCE_DIR}/src"
- "ENABLED_SECTIONS=INTERNAL\nINTERNAL_DOCS=yes")
+ "ENABLED_SECTIONS=INTERNAL\nINTERNAL_DOCS=yes\nEXTRACT_ALL=yes")
# This is not ideal: if files are added/removed it won't be detected til we re-run cmake.
file(GLOB_RECURSE API_SOURCES
@@ -45,6 +46,7 @@ if(USE_DOXYGEN)
add_custom_target(apidocs ALL DEPENDS user dev)
- install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/user/html/ DESTINATION ${QD_DOC_INSTALL_DIR}/api)
+ install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/user/ DESTINATION ${QD_DOC_INSTALL_DIR}/api)
+ install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/dev/ DESTINATION ${QD_DOC_INSTALL_DIR}/api_dev)
endif(USE_DOXYGEN)
Modified: qpid/dispatch/branches/0.3/doc/api/doxygen.in
URL: http://svn.apache.org/viewvc/qpid/dispatch/branches/0.3/doc/api/doxygen.in?rev=1653384&r1=1653383&r2=1653384&view=diff
==============================================================================
--- qpid/dispatch/branches/0.3/doc/api/doxygen.in (original)
+++ qpid/dispatch/branches/0.3/doc/api/doxygen.in Tue Jan 20 22:02:07 2015
@@ -17,10 +17,17 @@
# under the License.
#
-PROJECT_NAME = "Qpid Dispatch Library"
-OUTPUT_DIRECTORY = ${DOXYGEN_OUTPUT_DIRECTORY}
-INPUT = ${DOXYGEN_INPUT}
-RECURSIVE = yes
-JAVADOC_AUTOBRIEF = yes
-GENERATE_LATEX = no
-${DOXYGEN_MORE}
+PROJECT_NAME = "Qpid Dispatch Library"
+PROJECT_NUMBER = ${QPID_DISPATCH_VERSION}
+INPUT = ${INPUT}
+HTML_OUTPUT = ${HTML_OUTPUT}
+
+STRIP_FROM_PATH = ${CMAKE_SOURCE_DIR}/include
+DISABLE_INDEX = yes
+GENERATE_LATEX = no
+GENERATE_TREEVIEW = yes
+HAVE_DOT = ${USE_DOT}
+JAVADOC_AUTOBRIEF = yes
+QUIET = yes
+RECURSIVE = yes
+${MORE_CONFIG}
Modified: qpid/dispatch/branches/0.3/doc/book/schema_md.py
URL: http://svn.apache.org/viewvc/qpid/dispatch/branches/0.3/doc/book/schema_md.py?rev=1653384&r1=1653383&r2=1653384&view=diff
==============================================================================
--- qpid/dispatch/branches/0.3/doc/book/schema_md.py (original)
+++ qpid/dispatch/branches/0.3/doc/book/schema_md.py Tue Jan 20 22:02:07 2015
@@ -29,16 +29,17 @@ from qpid_dispatch_internal.management.s
class SchemaWriter(object):
"""Write the schema as a markdown document"""
- def __init__(self, out):
+ def __init__(self, out, quiet=True):
self.out = out
self.schema = QdSchema()
+ self.quiet = quiet
def write(self, value):
self.out.write(value)
def warn(self, message):
- print >>sys.stderr, message
+ if not self.quiet: print >>sys.stderr, message
def attribute(self, attr, thing):
default = attr.default
---------------------------------------------------------------------
To unsubscribe, e-mail: commits-unsubscribe@qpid.apache.org
For additional commands, e-mail: commits-help@qpid.apache.org