]> granicus.if.org Git - taglib/commitdiff
Move docs building to CMake
authorLukáš Lalinský <lalinsky@gmail.com>
Sun, 13 Feb 2011 12:22:42 +0000 (12:22 +0000)
committerLukáš Lalinský <lalinsky@gmail.com>
Sun, 13 Feb 2011 12:22:42 +0000 (12:22 +0000)
git-svn-id: svn://anonsvn.kde.org/home/kde/trunk/kdesupport/taglib@1220238 283d02a7-25f6-0310-bc7c-ecb5cbfe19da

CMakeLists.txt
Doxyfile.cmake [moved from doc/taglib.doxygen with 96% similarity]
doc/README
doc/api-header.html
taglib/toolkit/taglib.h

index d2cad2d4ee289bc2c2bccde719cbdf48781f81dc..5294fae66eb22bce45f8abae9aff5eca174e87ba 100644 (file)
@@ -75,3 +75,7 @@ if(NOT WIN32)
 endif(NOT WIN32)
 
 INSTALL( PROGRAMS  ${CMAKE_CURRENT_BINARY_DIR}/taglib-config DESTINATION ${BIN_INSTALL_DIR})
+
+CONFIGURE_FILE(${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile.cmake ${CMAKE_CURRENT_SOURCE_DIR}/Doxyfile)
+ADD_CUSTOM_TARGET(docs doxygen)
+
similarity index 96%
rename from doc/taglib.doxygen
rename to Doxyfile.cmake
index 9a7745af56c1c13d4db9e4b8977d8e11cd8d2c6d..7fdf41235d2487ba2572d46fe4f36125e95f60c3 100644 (file)
@@ -4,8 +4,8 @@
 # Project related configuration options
 #---------------------------------------------------------------------------
 PROJECT_NAME           = TagLib
-PROJECT_NUMBER         = 
-OUTPUT_DIRECTORY       = .
+PROJECT_NUMBER         = ${TAGLIB_LIB_VERSION_STRING}
+OUTPUT_DIRECTORY       = doc
 OUTPUT_LANGUAGE        = English
 USE_WINDOWS_ENCODING   = NO
 BRIEF_MEMBER_DESC      = YES
@@ -61,7 +61,7 @@ WARN_LOGFILE           =
 #---------------------------------------------------------------------------
 # configuration options related to the input files
 #---------------------------------------------------------------------------
-INPUT                  = ../taglib/
+INPUT                  = taglib
 FILE_PATTERNS          = *.h \
                          *.hh \
                          *.H
@@ -96,9 +96,9 @@ IGNORE_PREFIX          =
 GENERATE_HTML          = YES
 HTML_OUTPUT            = html
 HTML_FILE_EXTENSION    = .html
-HTML_HEADER            = api-header.html
-HTML_FOOTER            = api-footer.html
-HTML_STYLESHEET        = taglib-api.css
+HTML_HEADER            = doc/api-header.html
+HTML_FOOTER            = doc/api-footer.html
+HTML_STYLESHEET        = doc/taglib-api.css
 HTML_ALIGN_MEMBERS     = YES
 GENERATE_HTMLHELP      = NO
 CHM_FILE               = 
index ad634e1d4c273d4bc904578fae9a815a8215e91b..b2ebd36d68c5cfca8cef3b4f5fa3ee9d26a12f86 100644 (file)
@@ -1 +1 @@
-Run "doxygen taglib.doxgen" to generate the TagLib API documentation.
+Run "make docs" in the parent directory to generate the TagLib API documentation.
index 29fb5fc2554f7486072a5538d8a3c5952f50bea9..ab133c2587f73499bd1e093877a4f57e1eea9291 100644 (file)
@@ -17,7 +17,7 @@
             <td>
               <div id="intro">
                 <table border="0" height="119" cellpadding="0" cellspacing="0" width="100%">
-                    <tr><td valign="top"><h1>TagLib 1.6.3 ($title)</h1></td></tr>
+                    <tr><td valign="top"><h1>TagLib $projectnumber ($title)</h1></td></tr>
                     <tr>
                       <td valign="bottom">
                         <div id="links">
index d55138cd9411e8ca9310036bd43c0a0c46f03f3a..65a0c0b2dcef58f225abc648b0558cdbd5a1815f 100644 (file)
@@ -134,12 +134,9 @@ namespace TagLib {
  * Please see the <a href="http://developer.kde.org/~wheeler/taglib.html">TagLib website</a> for the latest
  * downloads.
  *
- * Instructions for installing TagLib vary per platform, but generally speaking on UNIX standard configure and
- * make commands are provided.  TagLib installs a taglib-config and package-config file to make it easier to
- * integrate into various build systems.  Note that TagLib's include install directory \e must be included in
- * the header include path.  Simply adding <taglib/tag.h> will \e not work.
- *
- * On Windows, TagLib can be built using the CMake build systems.
+ * TagLib can be built using the CMake build system. TagLib installs a taglib-config and pkg-config file to
+ * make it easier to integrate into various build systems.  Note that TagLib's include install directory \e must
+ * be included in the header include path. Simply adding <taglib/tag.h> will \e not work.
  *
  * \section start Getting Started
  *