diff options
author | Olli Salli <ollisal@gmail.com> | 2011-05-25 18:28:36 +0300 |
---|---|---|
committer | Olli Salli <ollisal@gmail.com> | 2011-05-25 18:28:38 +0300 |
commit | 5ec82e3726e6c8d0537f564dedfeeb59a0646482 (patch) | |
tree | eccf3a94527a3601ca380251a55218f1337d0b96 | |
parent | b348f69481e72f3239a38027ee7b59506ab1b5f1 (diff) | |
parent | 63b66df2597093e15868b4da42d71a90ba792c37 (diff) |
Merge branch 'doxygen-trivia-0.7'
Reviewed-by: Andre Magalhaes (andrunko) <andre.magalhaes@collabora.co.uk>
-rw-r--r-- | TelepathyQt4/optional-interface-factory.cpp | 4 | ||||
-rw-r--r-- | TelepathyQt4/optional-interface-factory.h | 2 | ||||
-rw-r--r-- | cmake/modules/Doxygen.cmake | 13 | ||||
-rw-r--r-- | doxygen.cfg.in | 7 | ||||
-rw-r--r-- | tools/CMakeLists.txt | 15 |
5 files changed, 38 insertions, 3 deletions
diff --git a/TelepathyQt4/optional-interface-factory.cpp b/TelepathyQt4/optional-interface-factory.cpp index 5f709bba..2580bc84 100644 --- a/TelepathyQt4/optional-interface-factory.cpp +++ b/TelepathyQt4/optional-interface-factory.cpp @@ -32,6 +32,8 @@ namespace Tp { +#ifndef DOXYGEN_SHOULD_SKIP_THIS + struct TELEPATHY_QT4_NO_EXPORT OptionalInterfaceCache::Private { QObject *proxy; @@ -85,6 +87,8 @@ void OptionalInterfaceCache::cache(AbstractInterface *interface) const mPriv->interfaces[name] = interface; } +#endif /* ifndef DOXYGEN_SHOULD_SKIP_THIS */ + /** * \class OptionalInterfaceFactory * \ingroup clientsideproxies diff --git a/TelepathyQt4/optional-interface-factory.h b/TelepathyQt4/optional-interface-factory.h index e26236f1..598d521b 100644 --- a/TelepathyQt4/optional-interface-factory.h +++ b/TelepathyQt4/optional-interface-factory.h @@ -63,7 +63,9 @@ private: #endif /* DOXYGEN_SHOULD_SKIP_THIS */ template <typename DBusProxySubclass> class OptionalInterfaceFactory +#ifndef DOXYGEN_SHOULD_SKIP_THIS : private OptionalInterfaceCache +#endif { Q_DISABLE_COPY(OptionalInterfaceFactory) diff --git a/cmake/modules/Doxygen.cmake b/cmake/modules/Doxygen.cmake index 12588784..804c217f 100644 --- a/cmake/modules/Doxygen.cmake +++ b/cmake/modules/Doxygen.cmake @@ -9,6 +9,19 @@ if(DOXYGEN_FOUND) include(FindPackageHandleStandardArgs) find_package_handle_standard_args(QHELPGENERATOR DEFAULT_MSG QHELPGENERATOR_EXECUTABLE) + set(QT_TAGS_FILE ${QT_DOC_DIR}/html/qt.tags) + if(EXISTS ${QT_TAGS_FILE}) + find_package(Perl) + + if (NOT PERL_FOUND) + message(WARNING "Perl was not found. Qt crosslinks in uploaded docs won't be valid.") + endif (NOT PERL_FOUND) + else(EXISTS ${QT_TAGS_FILE}) + message(WARNING "html/qt.tags not found in ${QT_DOC_DIR}. Set the QT_DOC_DIR variable to +point to its location to enable crosslinking.") + unset(QT_TAGS_FILE) + endif(EXISTS ${QT_TAGS_FILE}) + set(abs_top_builddir ${CMAKE_BINARY_DIR}) set(abs_top_srcdir ${CMAKE_SOURCE_DIR}) set(GENERATE_HTML YES) diff --git a/doxygen.cfg.in b/doxygen.cfg.in index 6fe395af..7d83450e 100644 --- a/doxygen.cfg.in +++ b/doxygen.cfg.in @@ -1209,12 +1209,15 @@ SKIP_FUNCTION_MACROS = YES # If a tag file is not located in the directory in which doxygen # is run, you must also specify the path to the tagfile here. -TAGFILES = +# FIXME: for some reason, doxygen doesn't seem to emit a doxygen= attribute at all +# in the <a> element if there is no location, in which case there is nothing for +# installdox to rewrite. +TAGFILES = ${QT_TAGS_FILE}=/you/forgot/to/run/installdox # When a file name is specified after GENERATE_TAGFILE, doxygen will create # a tag file that is based on the input files it reads. -GENERATE_TAGFILE = ${abs_top_builddir}/doc/${PROJECT}.tag +GENERATE_TAGFILE = ${abs_top_builddir}/doc/html/${PACKAGE_NAME}.tags # If the ALLEXTERNALS tag is set to YES all external classes will be listed # in the class index. If set to NO only the inherited external classes diff --git a/tools/CMakeLists.txt b/tools/CMakeLists.txt index e7963f70..3c023216 100644 --- a/tools/CMakeLists.txt +++ b/tools/CMakeLists.txt @@ -26,11 +26,24 @@ if (GIT_BRANCH_CURRENT) endif (HAVE_GIT_BRANCH) endif (GIT_BRANCH_CURRENT) +if (PERL_FOUND) + add_custom_target(maintainer-fix-qt-links-in-docs + ${PERL_EXECUTABLE} doc/html/installdox -l qt.tags@http://doc.qt.nokia.com/latest/ doc/html/*.html + + WORKING_DIRECTORY ${CMAKE_BINARY_DIR}) + add_dependencies(maintainer-fix-qt-links-in-docs doxygen-doc _maintainer-upload-release-check) +endif (PERL_FOUND) + add_custom_target(maintainer-upload-release-docs rsync -rtOvzPp --chmod=Dg+s,ug+rwX,o=rX doc/html/ telepathy.freedesktop.org:/srv/telepathy.freedesktop.org/www/doc/telepathy-qt4/ WORKING_DIRECTORY ${CMAKE_BINARY_DIR}) -add_dependencies(maintainer-upload-release-docs doxygen-doc _maintainer-upload-release-check) + +if (PERL_FOUND) + add_dependencies(maintainer-upload-release-docs maintainer-fix-qt-links-in-docs) +else (PERL_FOUND) + add_dependencies(maintainer-upload-release-docs doxygen-doc _maintainer-upload-release-check) +endif (PERL_FOUND) file(WRITE ${CMAKE_CURRENT_BINARY_DIR}/maintainer-upload-release-check.sh " #!/bin/sh |