Worked on providing a docs package for offline access

git-svn-id: http://opensource.mlba-team.de/svn/xdispatch/trunk@392 9e4c620c-c391-4b63-a7fb-4924991ea895

CMakeLists.txt

@@ -140,7 +140,11 @@ if( BUILD_XDISPATCH_TESTS)
 endif()
 
 # documentation
-option(XDISPATCH_DOCS "Set to add a documentation ('Docs') target" OFF)
+if( MZ_IS_RELEASE )
+    option(XDISPATCH_DOCS "Set to add a documentation ('Docs') target" ON)
+else()
+    option(XDISPATCH_DOCS "Set to add a documentation ('Docs') target" OFF)
+endif()
 if(XDISPATCH_DOCS)
 	include(docs/docgen.cmake)
 endif()

README.dox

@@ -21,7 +21,7 @@ The entire Grand Central Dispatch interface is available and can be found in \re
 Please note that including <dispatch/dispatch.h> is entirely sufficient and will
 automatically include all other headers as well.
 
-@subsubsection @section x111 Use of system provided implementations
+@subsubsection x111 Use of system provided implementations
 
 On some platforms (namely Mac OS) a version of the libdispatch library is installed by default.
 Consequently on each platform xdispatch is built on, the build system will automatically search for existing dispatch implementations  (possibly integrated
@@ -68,7 +68,7 @@ svn co http://opensource.mlba-team.de/svn/xdispatch/trunk
 @endcode
 
 Please be aware that this is a project still in progress. As such we might introduce interface
-changes and new functionality until reaching version 1.0 - have a look at the \ref changelog
+changes and new functionality until reaching version 1.0 - have a look at the \ref change_log
 for details and the current progress. When using this library within a project we recommend to use
 one of the tagged versions or the stable branch available by using subversion:
 

REQUIREMENTS.dox

@@ -34,7 +34,7 @@ recommended way when already using CMake. When doing so, all you need to do is t
 global includes to our include/ directory and linking your own targets with the targets xdispatch and/or QtDispatch.
 
 For examples and demonstrations of xdispatch and the Grand Central Dispatch approach, we recommend to have a look at \ref tutorial and refer to Apple's Online Documentation
-mentioned in the @ref into_sec.
+mentioned in the @ref intro_sec.
 
 @section build Building libXDispatch
 

docs/Doxyfile

@@ -853,21 +853,21 @@ HTML_DYNAMIC_SECTIONS  = YES
 # it at startup. 
 # See http://developer.apple.com/tools/creatingdocsetswithdoxygen.html for more information.
 
-GENERATE_DOCSET        = YES
+GENERATE_DOCSET        = NO
 
 # When GENERATE_DOCSET tag is set to YES, this tag determines the name of the 
 # feed. A documentation feed provides an umbrella under which multiple 
 # documentation sets from a single provider (such as a company or product suite) 
 # can be grouped.
 
-DOCSET_FEEDNAME        = "libXDispatch"
+DOCSET_FEEDNAME        = "XDispatch"
 
 # When GENERATE_DOCSET tag is set to YES, this tag specifies a string that 
 # should uniquely identify the documentation set bundle. This should be a 
 # reverse domain-name style string, e.g. com.mycompany.MyDocSet. Doxygen 
 # will append .docset to the name.
 
-DOCSET_BUNDLE_ID       = com.mlba.xdispatch
+DOCSET_BUNDLE_ID       = de.mlba-team.xdispatch
 
 # If the GENERATE_HTMLHELP tag is set to YES, additional index files 
 # will be generated that can be used as input for tools like the 
@@ -924,13 +924,13 @@ GENERATE_QHP           = YES
 # be used to specify the file name of the resulting .qch file. 
 # The path specified is relative to the HTML output folder.
 
-QCH_FILE               = com.mlba.xdispatch.qch
+QCH_FILE               = de.mlba-team.xdispatch.qch
 
 # The QHP_NAMESPACE tag specifies the namespace to use when generating 
 # Qt Help Project output. For more information please see 
 # http://doc.trolltech.com/qthelpproject.html#namespace
 
-QHP_NAMESPACE          = com.mlba.xdispatch
+QHP_NAMESPACE          = de.mlba-team.xdispatch
 
 # The QHP_VIRTUAL_FOLDER tag specifies the namespace to use when generating 
 # Qt Help Project output. For more information please see 

docs/docgen.cmake

@@ -19,8 +19,13 @@ set(DOXYGEN_DOT_EXECUTABLE "")
 if(DOXYGEN_FOUND)
 	configure_file(${CMAKE_CURRENT_SOURCE_DIR}/docs/Doxyfile
 				${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile)
+
+        # add to the default target
+        if( MZ_IS_RELEASE )
+            set( DOCS_DEFAULT_TARGET ALL )
+        endif()
 
-	add_custom_target(xdispatch_docs
+        add_custom_target(xdispatch_docs ${DOCS_DEFAULT_TARGET}
 		# delete old docs
 			${CMAKE_COMMAND} -E remove_directory ${CMAKE_CURRENT_BINARY_DIR}/docs/
 		# run doxygen
@@ -35,9 +40,27 @@ if(DOXYGEN_FOUND)
 		COMMAND ${QT_BINARY_DIR}/qhelpgenerator index.qhp -o ${EXECUTABLE_OUTPUT_PATH}/com.mlba.lemon.qch
 		WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/docs/html
 		COMMENT "Creating QT Docset"
-    )
+        )
+
+        # the install target for the docs
+        if(APPLE)
+            install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/docs/html
+                        DESTINATION "Library/Frameworks/xdispatch.framework/docs"
+                        COMPONENT xdispatch-doc
+                        PATTERN "*.svn" EXCLUDE)
+        elseif(UNIX)
+            install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/docs/html
+                        DESTINATION share/doc/xdispatch-doc
+                        COMPONENT xdispatch-doc
+                        PATTERN "*.svn" EXCLUDE)
+        else()
+            install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/docs
+                        DESTINATION doc
+                        COMPONENT xdispatch-doc
+                        PATTERN "*.svn" EXCLUDE)
+        endif()
 
 	message("-- Found Doxygen, adding Documentation for lemon (make lemon_docs)")
 else()
 	message("-- No Doxygen found, skipping Documentation for lemon")
-endif()
+endif()

docs/footer.htm

@@ -2,7 +2,7 @@
 Generated on $datetime for $projectname by&nbsp;<a href="http://www.doxygen.org/index.html">Doxygen $doxygenversion</a><br/>
 &copy 2010-2012 MLBA (<a href="http://www.mlba-team.de/impressum.htm">about</a> | <a href="http://www.mlba-team.de/impressum.htm">privacy</a>) All Rights reserved.</small></address>
 
-<!-- Piwik -->
+<!-- Piwik 
 <script type="text/javascript">
 var pkBaseURL = (("https:" == document.location.protocol) ? "https://stats.mlba-team.de/piwik/" : "http://stats.mlba-team.de/piwik/");
 document.write(unescape("%3Cscript src='" + pkBaseURL + "piwik.js' type='text/javascript'%3E%3C/script%3E"));

docs/header.htm

@@ -11,7 +11,7 @@
 	</script>
 </head><body>
 <div class="custom_header" style="padding-left: 150px;">XDispatch 0.7.0</div>
-
+<!--
 <div id="global_nav">
 	<a href="http://opensource.mlba-team.de/xdispatch/news.htm">
 		<div class="global_nav_item" style="background-image: URL(nav_news.png);">
@@ -38,3 +38,4 @@
 		</div>
 	</a>
 </div>
+-->

package/ubuntu/control

@@ -4,12 +4,19 @@ Section: devel
 Maintainer: Marius Zwicker <[email protected]>
 Build-Depends: debhelper (>= 7.0.50~), quilt (>= 0.46-7~), cmake,
  libc6, libgcc1, clang, libqt4-core, libqt4-gui,
- libqt4-network, libqt4-dev, libblocksruntime-dev
+ libqt4-network, libqt4-dev, libblocksruntime-dev, doxygen
 Standards-Version: 3.9.1
 Vcs-Svn: https://opensource.mlba-team.de/svn/xdispatch
 Vcs-Browser: http://opensource.mlba-team.de/websvn/listing.php?repname=libXDispatch
 Homepage: http://opensource.mlba-team.de/xdispatch
 
+Package: xdispatch-doc
+Section: universe/doc
+Architecture: all
+Depends: libdispatch-dev (= ${binary:Version}), libxdispatch-dev (= ${binary:Version})
+Description: Userspace implementation of grand central dispatch (API Docs)
+ Documentation files for libdispatch, libxdispatch and libqtdispatch
+
 Package: libdispatch
 Section: libs
 Architecture: any
@@ -24,6 +31,7 @@ Package: libdispatch-dev
 Section: libdevel
 Architecture: any
 Depends: ${misc:Depends}, libdispatch (= ${binary:Version}), pkg-config
+Suggests: xdispatch-doc
 Description: development files for libdispatch
  Userspace implementation of grand central dispatch API - Development Files
  .
@@ -50,6 +58,7 @@ Section: libdevel
 Architecture: any
 Depends: ${misc:Depends}, libxdispatch (= ${binary:Version}), pkg-config,
   libdispatch-dev
+Suggests: xdispatch-doc
 Description: development files for libxdispatch
  C++ API for Grand Central Dispatch - Development Files
  .
@@ -78,6 +87,7 @@ Section: libdevel
 Architecture: any
 Depends: ${misc:Depends}, libqtdispatch (= ${binary:Version}), 
  pkg-config, libqt4-dev, libdispatch-dev, libxdispatch-dev
+Suggests: xdispatch-doc
 Description: development files for libQtDispatch
  Qt compatible API wrapper for Grand Central Dispatch - Development Files
  .

package/ubuntu/libdispatch.postrm

@@ -0,0 +1,2 @@
+#!/bin/bash
+rm -rf /usr/share/doc/libdispatch

package/ubuntu/libqtdispatch.postrm

@@ -0,0 +1,2 @@
+#!/bin/bash
+rm -rf /usr/share/doc/libqtdispatch

package/ubuntu/libxdispatch.postrm

@@ -0,0 +1,2 @@
+#!/bin/bash
+rm -rf /usr/share/doc/libxdispatch

package/ubuntu/xdispatch-doc.install

@@ -0,0 +1 @@
+usr/share/doc/xdispatch-doc/html

package/ubuntu/xdispatch-doc.postinst

@@ -0,0 +1,4 @@
+#!/bin/bash
+ln -s /usr/share/doc/xdispatch-doc/html /usr/share/doc/libdispatch
+ln -s /usr/share/doc/xdispatch-doc/html /usr/share/doc/libxdispatch
+ln -s /usr/share/doc/xdispatch-doc/html /usr/share/doc/libqtdispatch

package/ubuntu/xdispatch-doc.prerm

@@ -0,0 +1,4 @@
+#!/bin/bash
+rm -f /usr/share/doc/libdispatch/html
+rm -f /usr/share/doc/libxdispatch/html
+rm -f /usr/share/doc/libqtdispatch/html

package/version.cmake

@@ -57,9 +57,9 @@ if(APPLE)
     set( CPACK_COMPONENTS_ALL libxdispatch libQtDispatch )
 else()
     if(UNIX AND NOT APPLE)
-        set( CPACK_COMPONENTS_ALL libdispatch libdispatch-dev libxdispatch libxdispatch-dev libQtDispatch libQtDispatch-dev )
+        set( CPACK_COMPONENTS_ALL libdispatch libdispatch-dev libxdispatch libxdispatch-dev libQtDispatch libQtDispatch-dev xdispatch-doc )
     else()
-        set( CPACK_COMPONENTS_ALL libdispatch libxdispatch libQtDispatch )
+        set( CPACK_COMPONENTS_ALL libdispatch libxdispatch libQtDispatch xdispatch-doc )
     endif()
 endif()
 
@@ -85,6 +85,9 @@ set( CPACK_COMPONENT_LIBQTDISPATCH_DEPENDS libxdispatch)
 set( CPACK_COMPONENT_LIBQTDISPATCH-DEV_DISPLAY_NAME "QtDispatch - Development Files")
 set( CPACK_COMPONENT_LIBQTDISPATCH-DEV_DESCRIPTION "Provides integration of Grand Central Dispatch into the Qt Event-Loop. Additionally a QThreadPool compatible API to Grand Central Dispatch is provided")
 set( CPACK_COMPONENT_LIBQTDISPATCH-DEV_DEPENDS libQtDispatch)
+set( CPACK_COMPONENT_XDISPATCH_DOC_DISPLAY_NAME "API Documentation")
+set( CPACK_COMPONENT_XDISPATCH_DOC_DESCRIPTION "Documentation for libxdispatch, libdispatch and libqtdispatch. API Reference, tutorials and further information")
+set( CPACK_COMPONENT_XDISPATCH_DOC_DEPENDS libxdispatch-dev)