Add the docs from my old repository.
authorScott Wheeler <wheeler@kde.org>
Thu, 31 Jan 2008 17:00:56 +0000 (17:00 +0000)
committerScott Wheeler <wheeler@kde.org>
Thu, 31 Jan 2008 17:00:56 +0000 (17:00 +0000)
git-svn-id: svn://anonsvn.kde.org/home/kde/trunk/kdesupport/taglib@769145 283d02a7-25f6-0310-bc7c-ecb5cbfe19da

Makefile.am
doc/README [new file with mode: 0644]
doc/api-footer.html [new file with mode: 0644]
doc/api-header.html [new file with mode: 0644]
doc/taglib-api.css [new file with mode: 0644]
doc/taglib.doxygen [new file with mode: 0644]
doc/taglib.png [new file with mode: 0644]

index 3f598339ecbf50d86cc9cdae970a2cb93f5352ad..f454f7ef0fe94cc64b6d0ec8b32d2921fc65ef80 100644 (file)
@@ -38,7 +38,7 @@ apidox:
        fi; \
        cp $(top_srcdir)/admin/Doxyfile.global taglib.doxyfile; \
        echo "PROJECT_NAME        = TagLib" >> taglib.doxyfile; \
-       echo "PROJECT_NUMBER      = \"Version 1.1\"" >> taglib.doxyfile; \
+       echo "PROJECT_NUMBER      = \"Version 1.5\"" >> taglib.doxyfile; \
        echo "INPUT               = $(srcdir)" >> taglib.doxyfile; \
        echo "OUTPUT_DIRECTORY    = doc/api" >> taglib.doxyfile; \
        echo "HTML_OUTPUT         = html" >> taglib.doxyfile; \
diff --git a/doc/README b/doc/README
new file mode 100644 (file)
index 0000000..ad634e1
--- /dev/null
@@ -0,0 +1 @@
+Run "doxygen taglib.doxgen" to generate the TagLib API documentation.
diff --git a/doc/api-footer.html b/doc/api-footer.html
new file mode 100644 (file)
index 0000000..9b151ee
--- /dev/null
@@ -0,0 +1,4 @@
+      </div>
+    </div>
+  </body>
+</html>
diff --git a/doc/api-header.html b/doc/api-header.html
new file mode 100644 (file)
index 0000000..91e7dc5
--- /dev/null
@@ -0,0 +1,41 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
+<html>
+  <head>
+    <title>$title ($projectname)</title>
+    <link href="taglib-api.css" rel="stylesheet" type="text/css">
+  </head>
+  <body>
+
+    
+    <div id="container">
+
+      <table border="0" width="100%">
+          <tr>
+            <td width="1">
+              <img src="../taglib.png">
+            </td>
+            <td>
+              <div id="intro">
+                <table border="0" height="119" cellpadding="0" cellspacing="0" width="100%">
+                    <tr><td valign="top"><h1>TagLib 1.5 ($title)</h1></td></tr>
+                    <tr>
+                      <td valign="bottom">
+                        <div id="links">
+                          <a href="index.html">Home</a>
+                          <a href="inherits.html">Class&nbsp;Hierarchy</a>
+                          <a href="namespaces.html">Namespaces</a>
+                          <a href="annotated.html">Classes</a>
+                          <a href="files.html">Headers</a>
+                          <a href="namespacemembers.html">Namespace&nbsp;Members</a>
+                          <a href="functions.html">Class&nbsp;Members</a>
+                          <a href="globals.html">File&nbsp;Members</a>
+                        </div>
+                      </td>
+                    </tr>
+                </table>
+              </div>
+            </td>
+          </tr>
+      </table>
+
+      <div id="text">
diff --git a/doc/taglib-api.css b/doc/taglib-api.css
new file mode 100644 (file)
index 0000000..d294b32
--- /dev/null
@@ -0,0 +1,386 @@
+body {
+  font-family: sans-serif;
+  background: white;
+  color: black;
+  margin: 0px;
+  padding: 15px;
+}
+
+a:link {
+  font-weight: bold;
+  text-decoration: none;
+  color: gray;
+}
+
+a:visited {
+  font-weight: bold;
+  text-decoration: none;
+  color: gray;
+}
+
+a:hover {
+  color: #cccccc;
+  text-decoration: underline;
+}
+
+a:active {
+  color: #cccccc;
+  text-decoration: underline;
+}
+
+img { 
+  border-style: none;
+}
+
+h1 {
+  font-family: sans-serif;
+}
+
+h2 {
+  font-family: sans-serif;
+}
+
+h3 {
+  font-family: sans-serif;
+}
+
+/* container */
+
+#container {
+  position: absolute;
+  border-width: thin;
+  border-style: solid;
+  width: 95%;
+}
+
+/* intro */
+
+#intro {
+  padding: 5px;
+  margin: 0px;
+  background: #cccccc;
+  border-width: medium;
+  border-style: solid;
+}
+
+#intro h1 {
+  margin: 5px;
+  padding: 5px;
+}
+
+/* links */
+
+#links { 
+  font-size: x-small;
+  vertical-align: bottom;
+}
+
+#links a {
+  border-width: thin;
+  border-style: dotted;
+  border-color: white;
+  /* margin: 0px 10px 0px 0px; */
+  margin: 1px;
+  padding: 3px;
+  line-height: 230%
+}
+
+#links a:hover {
+  color: black;
+  text-decoration: underline;
+}
+
+#links h3 {
+  outline-width: thin;
+  border-style: solid;
+  padding: 2px;
+  margin: 3px 0px 3px 0px;
+}
+
+/* menu */
+
+#menu h3 {
+  text-align: center;
+}
+
+/* text */
+
+#text {
+  margin: 0px;
+  padding: 5px 5px 0px 5px;
+  float: left;
+}
+
+#text h3 {
+  border-width: thin;
+  border-style: solid;
+  padding: 2px;
+  margin: 3px 0px 3px 0px;
+}
+
+#text li {
+  margin: 0px 0px 10px 0px;
+}
+
+#text ul {
+  margin: 5px;
+  padding: 0px 0px 0px 20px;
+}
+
+#leftcolumn {
+  float: left;
+  width: 300px;
+  margin: 0px 10px 0px 0px;
+  padding: 0px;
+}
+
+#rightcolumn {
+  float: right;
+  width: 210px;
+  margin: 0px;
+  padding: 0px;
+}
+
+/* vspacer */
+
+.vspacer {
+  height: 10px;
+}
+
+.silver {
+  border-width: thin;
+  border-color: black;
+  border-style: solid;
+  background: #cccccc;
+}
+
+a.code {
+  text-decoration: none;
+  font-weight: normal;
+  color: #4444ee
+}
+
+a.codeRef {
+  font-weight: normal;
+  color: #4444ee
+}
+
+div.fragment {
+  width: 98%;
+  border: 1px solid #CCCCCC;
+  background-color: #f5f5f5;
+  padding-left: 4px;
+  margin: 4px;
+}
+
+div.ah {
+  background-color: black;
+  font-weight: bold; color: #ffffff;
+  margin-bottom: 3px;
+  margin-top: 3px
+}
+
+td.md {
+  background-color: #f2f2ff;
+  font-weight: bold;
+}
+
+td.mdname1 {
+  background-color: #f2f2ff;
+  font-weight: bold;
+  color: #602020;
+}
+
+td.mdname {
+  background-color: #f2f2ff;
+  font-weight: bold;
+  color: #602020;
+  width: 600px;
+}
+
+div.groupHeader {
+  margin-left: 16px;
+  margin-top: 12px;
+  margin-bottom: 6px;
+  font-weight: bold
+}
+
+div.groupText {
+  margin-left: 16px;
+  font-style: italic;
+  font-size: smaller
+}
+
+body {
+  background: white;
+  color: black;
+  margin-right: 20px;
+  margin-left: 20px;
+}
+
+td.indexkey { 
+  background-color: #eeeeff; 
+  font-weight: bold; 
+  padding-right  : 10px; 
+  padding-top    : 2px; 
+  padding-left   : 10px; 
+  padding-bottom : 2px; 
+  margin-left    : 0px; 
+  margin-right   : 0px; 
+  margin-top     : 2px; 
+  margin-bottom  : 2px  
+}
+
+td.indexvalue { 
+  background-color: #eeeeff; 
+  font-style: italic; 
+  padding-right  : 10px; 
+  padding-top    : 2px; 
+  padding-left   : 10px; 
+  padding-bottom : 2px; 
+  margin-left    : 0px; 
+  margin-right   : 0px; 
+  margin-top     : 2px; 
+  margin-bottom  : 2px  
+}
+
+tr.memlist {
+  background-color: #f0f0f0; 
+}
+
+p.formulaDsp {
+  text-align: center;
+}
+
+img.formulaDsp {
+
+}
+
+img.formulaInl {
+  vertical-align: middle;
+}
+
+span.keyword {
+  color: #008000
+}
+
+span.keywordtype {
+  color: #604020
+}
+
+span.keywordflow {
+  color: #e08000
+}
+
+span.comment {
+  color: #800000
+}
+
+span.preprocessor {
+  color: #806020
+}
+
+span.stringliteral {
+  color: #002080
+}
+
+span.charliteral {
+  color: #008080
+}
+
+.mdTable {
+  border: 1px solid #868686;
+  background-color: #f2f2ff;
+}
+
+.mdRow {
+  padding: 8px 20px;
+}
+
+.mdescLeft {
+  font-size: smaller;
+  font-family: Arial, Helvetica, sans-serif;
+  background-color: #FAFAFA;
+  padding-left: 8px;
+  border-top: 1px none #E0E0E0;
+  border-right: 1px none #E0E0E0;
+  border-bottom: 1px none #E0E0E0;
+  border-left: 1px none #E0E0E0;
+  margin: 0px;
+}
+
+.mdescRight {
+  font-size: smaller;
+  font-family: Arial, Helvetica, sans-serif;
+  font-style: italic;
+  background-color: #FAFAFA;
+  padding-left: 4px;
+  border-top: 1px none #E0E0E0;
+  border-right: 1px none #E0E0E0;
+  border-bottom: 1px none #E0E0E0;
+  border-left: 1px none #E0E0E0;
+  margin: 0px;
+  padding-bottom: 0px;
+  padding-right: 8px;
+}
+
+.memItemLeft {
+  padding: 1px 0px 0px 8px;
+  margin: 4px;
+  border-top-width: 1px;
+  border-right-width: 1px;
+  border-bottom-width: 1px;
+  border-left-width: 1px;
+  border-top-style: solid;
+  border-top-color: #E0E0E0;
+  border-right-color: #E0E0E0;
+  border-bottom-color: #E0E0E0;
+  border-left-color: #E0E0E0;
+  border-right-style: none;
+  border-bottom-style: none;
+  border-left-style: none;
+  background-color: #FAFAFA;
+  font-family: Geneva, Arial, Helvetica, sans-serif;
+  font-size: 12px;
+}
+
+.memItemRight {
+  padding: 1px 0px 0px 8px;
+  margin: 4px;
+  border-top-width: 1px;
+  border-right-width: 1px;
+  border-bottom-width: 1px;
+  border-left-width: 1px;
+  border-top-style: solid;
+  border-top-color: #E0E0E0;
+  border-right-color: #E0E0E0;
+  border-bottom-color: #E0E0E0;
+  border-left-color: #E0E0E0;
+  border-right-style: none;
+  border-bottom-style: none;
+  border-left-style: none;
+  background-color: #FAFAFA;
+  font-family: Geneva, Arial, Helvetica, sans-serif;
+  font-size: 13px;
+}
+
+.search {
+  color: #0000ee;
+  font-weight: bold;
+}
+
+form.search {
+  margin-bottom: 0px;
+  margin-top: 0px;
+}
+
+input.search {
+  font-size: 75%;
+  color: #000080;
+  font-weight: normal;
+  background-color: #eeeeff;
+}
+
+td.tiny {
+  font-size: 75%;
+}
diff --git a/doc/taglib.doxygen b/doc/taglib.doxygen
new file mode 100644 (file)
index 0000000..f31c0f1
--- /dev/null
@@ -0,0 +1,208 @@
+# Doxyfile 1.3.4
+
+#---------------------------------------------------------------------------
+# Project related configuration options
+#---------------------------------------------------------------------------
+PROJECT_NAME           = TagLib
+PROJECT_NUMBER         = 
+OUTPUT_DIRECTORY       = .
+OUTPUT_LANGUAGE        = English
+USE_WINDOWS_ENCODING   = NO
+BRIEF_MEMBER_DESC      = YES
+REPEAT_BRIEF           = YES
+ALWAYS_DETAILED_SEC    = NO
+INLINE_INHERITED_MEMB  = NO
+FULL_PATH_NAMES        = NO
+STRIP_FROM_PATH        = 
+SHORT_NAMES            = NO
+JAVADOC_AUTOBRIEF      = NO
+MULTILINE_CPP_IS_BRIEF = NO
+DETAILS_AT_TOP         = NO
+INHERIT_DOCS           = YES
+DISTRIBUTE_GROUP_DOC   = NO
+TAB_SIZE               = 4
+ALIASES                = 
+OPTIMIZE_OUTPUT_FOR_C  = NO
+OPTIMIZE_OUTPUT_JAVA   = NO
+SUBGROUPING            = YES
+#---------------------------------------------------------------------------
+# Build related configuration options
+#---------------------------------------------------------------------------
+EXTRACT_ALL            = YES
+EXTRACT_PRIVATE        = NO
+EXTRACT_STATIC         = NO
+EXTRACT_LOCAL_CLASSES  = NO
+HIDE_UNDOC_MEMBERS     = NO
+HIDE_UNDOC_CLASSES     = NO
+HIDE_FRIEND_COMPOUNDS  = NO
+HIDE_IN_BODY_DOCS      = NO
+INTERNAL_DOCS          = YES
+CASE_SENSE_NAMES       = YES
+HIDE_SCOPE_NAMES       = NO
+SHOW_INCLUDE_FILES     = YES
+INLINE_INFO            = YES
+SORT_MEMBER_DOCS       = YES
+GENERATE_TODOLIST      = NO
+GENERATE_TESTLIST      = NO
+GENERATE_BUGLIST       = NO
+GENERATE_DEPRECATEDLIST= NO
+ENABLED_SECTIONS       = 
+MAX_INITIALIZER_LINES  = 30
+SHOW_USED_FILES        = YES
+#---------------------------------------------------------------------------
+# configuration options related to warning and progress messages
+#---------------------------------------------------------------------------
+QUIET                  = NO
+WARNINGS               = YES
+WARN_IF_UNDOCUMENTED   = NO
+WARN_IF_DOC_ERROR      = YES
+WARN_FORMAT            = "$file:$line: $text"
+WARN_LOGFILE           = 
+#---------------------------------------------------------------------------
+# configuration options related to the input files
+#---------------------------------------------------------------------------
+INPUT                  = ../taglib/
+FILE_PATTERNS          = *.h \
+                         *.hh \
+                         *.H
+RECURSIVE              = YES
+EXCLUDE                = 
+EXCLUDE_SYMLINKS       = NO
+EXCLUDE_PATTERNS       = 
+EXAMPLE_PATH           = 
+EXAMPLE_PATTERNS       = 
+EXAMPLE_RECURSIVE      = NO
+IMAGE_PATH             = 
+INPUT_FILTER           = 
+FILTER_SOURCE_FILES    = NO
+#---------------------------------------------------------------------------
+# configuration options related to source browsing
+#---------------------------------------------------------------------------
+SOURCE_BROWSER         = NO
+INLINE_SOURCES         = NO
+STRIP_CODE_COMMENTS    = YES
+REFERENCED_BY_RELATION = YES
+REFERENCES_RELATION    = YES
+VERBATIM_HEADERS       = YES
+#---------------------------------------------------------------------------
+# configuration options related to the alphabetical class index
+#---------------------------------------------------------------------------
+ALPHABETICAL_INDEX     = YES
+COLS_IN_ALPHA_INDEX    = 5
+IGNORE_PREFIX          = 
+#---------------------------------------------------------------------------
+# configuration options related to the HTML output
+#---------------------------------------------------------------------------
+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_ALIGN_MEMBERS     = YES
+GENERATE_HTMLHELP      = NO
+CHM_FILE               = 
+HHC_LOCATION           = 
+GENERATE_CHI           = NO
+BINARY_TOC             = NO
+TOC_EXPAND             = NO
+DISABLE_INDEX          = YES
+ENUM_VALUES_PER_LINE   = 4
+GENERATE_TREEVIEW      = NO
+TREEVIEW_WIDTH         = 250
+#---------------------------------------------------------------------------
+# configuration options related to the LaTeX output
+#---------------------------------------------------------------------------
+GENERATE_LATEX         = NO
+LATEX_OUTPUT           = latex
+LATEX_CMD_NAME         = latex
+MAKEINDEX_CMD_NAME     = makeindex
+COMPACT_LATEX          = NO
+PAPER_TYPE             = letter
+EXTRA_PACKAGES         = 
+LATEX_HEADER           = 
+PDF_HYPERLINKS         = YES
+USE_PDFLATEX           = YES
+LATEX_BATCHMODE        = NO
+LATEX_HIDE_INDICES     = NO
+#---------------------------------------------------------------------------
+# configuration options related to the RTF output
+#---------------------------------------------------------------------------
+GENERATE_RTF           = NO
+RTF_OUTPUT             = rtf
+COMPACT_RTF            = NO
+RTF_HYPERLINKS         = NO
+RTF_STYLESHEET_FILE    = 
+RTF_EXTENSIONS_FILE    = 
+#---------------------------------------------------------------------------
+# configuration options related to the man page output
+#---------------------------------------------------------------------------
+GENERATE_MAN           = NO
+MAN_OUTPUT             = man
+MAN_EXTENSION          = .3
+MAN_LINKS              = NO
+#---------------------------------------------------------------------------
+# configuration options related to the XML output
+#---------------------------------------------------------------------------
+GENERATE_XML           = NO
+XML_OUTPUT             = xml
+XML_SCHEMA             = 
+XML_DTD                = 
+#---------------------------------------------------------------------------
+# configuration options for the AutoGen Definitions output
+#---------------------------------------------------------------------------
+GENERATE_AUTOGEN_DEF   = NO
+#---------------------------------------------------------------------------
+# configuration options related to the Perl module output
+#---------------------------------------------------------------------------
+GENERATE_PERLMOD       = NO
+PERLMOD_LATEX          = NO
+PERLMOD_PRETTY         = YES
+PERLMOD_MAKEVAR_PREFIX = 
+#---------------------------------------------------------------------------
+# Configuration options related to the preprocessor   
+#---------------------------------------------------------------------------
+ENABLE_PREPROCESSING   = YES
+MACRO_EXPANSION        = NO
+EXPAND_ONLY_PREDEF     = NO
+SEARCH_INCLUDES        = YES
+INCLUDE_PATH           = 
+INCLUDE_FILE_PATTERNS  = 
+PREDEFINED             = DO_NOT_DOCUMENT \
+                         DOXYGEN
+EXPAND_AS_DEFINED      = 
+SKIP_FUNCTION_MACROS   = YES
+#---------------------------------------------------------------------------
+# Configuration::addtions related to external references   
+#---------------------------------------------------------------------------
+TAGFILES               = 
+GENERATE_TAGFILE       = 
+ALLEXTERNALS           = NO
+EXTERNAL_GROUPS        = YES
+PERL_PATH              = /usr/bin/perl
+#---------------------------------------------------------------------------
+# Configuration options related to the dot tool   
+#---------------------------------------------------------------------------
+CLASS_DIAGRAMS         = YES
+HIDE_UNDOC_RELATIONS   = YES
+HAVE_DOT               = YES
+CLASS_GRAPH            = YES
+COLLABORATION_GRAPH    = YES
+UML_LOOK               = NO
+TEMPLATE_RELATIONS     = YES
+INCLUDE_GRAPH          = YES
+INCLUDED_BY_GRAPH      = YES
+CALL_GRAPH             = NO
+GRAPHICAL_HIERARCHY    = YES
+DOT_IMAGE_FORMAT       = png
+DOT_PATH               = 
+DOTFILE_DIRS           = 
+MAX_DOT_GRAPH_WIDTH    = 1024
+MAX_DOT_GRAPH_HEIGHT   = 1024
+MAX_DOT_GRAPH_DEPTH    = 0
+GENERATE_LEGEND        = YES
+DOT_CLEANUP            = YES
+#---------------------------------------------------------------------------
+# Configuration::addtions related to the search engine   
+#---------------------------------------------------------------------------
+SEARCHENGINE           = NO
diff --git a/doc/taglib.png b/doc/taglib.png
new file mode 100644 (file)
index 0000000..7174ee9
Binary files /dev/null and b/doc/taglib.png differ