Author: aconway
Date: Mon Apr 7 20:42:58 2014
New Revision: 1585582
URL: http://svn.apache.org/r1585582
Log:
NO-JIRA: Added doxygen API doc generation to doc/api/CMakeLists.txt
Added:
qpid/dispatch/trunk/doc/api/
qpid/dispatch/trunk/doc/api/CMakeLists.txt (with props)
qpid/dispatch/trunk/doc/api/dev.doxygen.in
qpid/dispatch/trunk/doc/api/user.doxygen.in
Modified:
qpid/dispatch/trunk/doc/CMakeLists.txt
qpid/dispatch/trunk/doc/notes/code-conventions.md
Modified: qpid/dispatch/trunk/doc/CMakeLists.txt
URL:
http://svn.apache.org/viewvc/qpid/dispatch/trunk/doc/CMakeLists.txt?rev=1585582&r1=1585581&r2=1585582&view=diff
==============================================================================
--- qpid/dispatch/trunk/doc/CMakeLists.txt (original)
+++ qpid/dispatch/trunk/doc/CMakeLists.txt Mon Apr 7 20:42:58 2014
@@ -24,3 +24,5 @@ configure_file(man/qdstat.8.in ${CMAKE_C
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/man/qdrouterd.8 DESTINATION
${MAN_INSTALL_DIR}/man8)
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/man/qdrouterd.conf.5 DESTINATION
${MAN_INSTALL_DIR}/man5)
install(FILES ${CMAKE_CURRENT_BINARY_DIR}/man/qdstat.8 DESTINATION
${MAN_INSTALL_DIR}/man8)
+
+add_subdirectory(api)
Added: qpid/dispatch/trunk/doc/api/CMakeLists.txt
URL:
http://svn.apache.org/viewvc/qpid/dispatch/trunk/doc/api/CMakeLists.txt?rev=1585582&view=auto
==============================================================================
--- qpid/dispatch/trunk/doc/api/CMakeLists.txt (added)
+++ qpid/dispatch/trunk/doc/api/CMakeLists.txt Mon Apr 7 20:42:58 2014
@@ -0,0 +1,44 @@
+##
+## 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.
+##
+
+find_package(Doxygen)
+if (DOXYGEN_FOUND)
+ option(BUILD_DOCS "Build documentation with doxygen" ON)
+endif (DOXYGEN_FOUND)
+
+if (BUILD_DOCS)
+ configure_file(user.doxygen.in user.doxygen)
+ configure_file(dev.doxygen.in dev.doxygen)
+ # This is not ideal: if files are added/removed it won't be detected
+ # until we re-run cmake.
+ file(GLOB_RECURSE API_SOURCES
+ ${CMAKE_SOURCE_DIR}/include/*.h
+ ${CMAKE_SOURCE_DIR}/src/*.h
+ ${CMAKE_SOURCE_DIR}/src/*.c)
+
+ add_custom_command (OUTPUT user
+ COMMAND ${DOXYGEN_EXECUTABLE} user.doxygen
+ DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/user.doxygen.in ${API_SOURCES})
+ add_custom_command (OUTPUT dev
+ COMMAND ${DOXYGEN_EXECUTABLE} dev.doxygen
+ DEPENDS ${CMAKE_CURRENT_SOURCE_DIR}/dev.doxygen.in ${API_SOURCES})
+
+ add_custom_target(apidocs ALL DEPENDS user dev)
+
+endif (BUILD_DOCS)
Propchange: qpid/dispatch/trunk/doc/api/CMakeLists.txt
------------------------------------------------------------------------------
svn:eol-style = native
Propchange: qpid/dispatch/trunk/doc/api/CMakeLists.txt
------------------------------------------------------------------------------
svn:mime-type = text/plain
Added: qpid/dispatch/trunk/doc/api/dev.doxygen.in
URL:
http://svn.apache.org/viewvc/qpid/dispatch/trunk/doc/api/dev.doxygen.in?rev=1585582&view=auto
==============================================================================
--- qpid/dispatch/trunk/doc/api/dev.doxygen.in (added)
+++ qpid/dispatch/trunk/doc/api/dev.doxygen.in Mon Apr 7 20:42:58 2014
@@ -0,0 +1,23 @@
+#
+# 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.
+#
+
+PROJECT_NAME = "Dispatch"
+OUTPUT_DIRECTORY = dev
+INPUT = ${CMAKE_SOURCE_DIR}/include ${CMAKE_SOURCE_DIR}/src
+RECURSIVE = yes
Added: qpid/dispatch/trunk/doc/api/user.doxygen.in
URL:
http://svn.apache.org/viewvc/qpid/dispatch/trunk/doc/api/user.doxygen.in?rev=1585582&view=auto
==============================================================================
--- qpid/dispatch/trunk/doc/api/user.doxygen.in (added)
+++ qpid/dispatch/trunk/doc/api/user.doxygen.in Mon Apr 7 20:42:58 2014
@@ -0,0 +1,23 @@
+#
+# 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.
+#
+
+PROJECT_NAME = "Dispatch"
+OUTPUT_DIRECTORY = user
+INPUT = ${CMAKE_SOURCE_DIR}/include
+RECURSIVE = yes
Modified: qpid/dispatch/trunk/doc/notes/code-conventions.md
URL:
http://svn.apache.org/viewvc/qpid/dispatch/trunk/doc/notes/code-conventions.md?rev=1585582&r1=1585581&r2=1585582&view=diff
==============================================================================
--- qpid/dispatch/trunk/doc/notes/code-conventions.md (original)
+++ qpid/dispatch/trunk/doc/notes/code-conventions.md Mon Apr 7 20:42:58 2014
@@ -27,4 +27,4 @@ Python code should be [PEP-8][pep8] comp
- Do not use studlyCaps for function, method, and variable names;
instead use underscore_separated_names
-[pep8] http://www.python.org/dev/peps/pep-0008/
+[pep8]: http://www.python.org/dev/peps/pep-0008/
---------------------------------------------------------------------
To unsubscribe, e-mail: [email protected]
For additional commands, e-mail: [email protected]
