From ab3c78ffebac535155846c81fb96a11c723cd833 Mon Sep 17 00:00:00 2001 From: Scott Wheeler Date: Thu, 31 Jan 2008 17:00:56 +0000 Subject: [PATCH] Add the docs from my old repository. git-svn-id: svn://anonsvn.kde.org/home/kde/trunk/kdesupport/taglib@769145 283d02a7-25f6-0310-bc7c-ecb5cbfe19da --- Makefile.am | 2 +- doc/README | 1 + doc/api-footer.html | 4 + doc/api-header.html | 41 +++++ doc/taglib-api.css | 386 ++++++++++++++++++++++++++++++++++++++++++++ doc/taglib.doxygen | 208 ++++++++++++++++++++++++ doc/taglib.png | Bin 0 -> 3451 bytes 7 files changed, 641 insertions(+), 1 deletion(-) create mode 100644 doc/README create mode 100644 doc/api-footer.html create mode 100644 doc/api-header.html create mode 100644 doc/taglib-api.css create mode 100644 doc/taglib.doxygen create mode 100644 doc/taglib.png diff --git a/Makefile.am b/Makefile.am index 3f598339e..f454f7ef0 100644 --- a/Makefile.am +++ b/Makefile.am @@ -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 index 000000000..ad634e1d4 --- /dev/null +++ b/doc/README @@ -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 index 000000000..9b151ee89 --- /dev/null +++ b/doc/api-footer.html @@ -0,0 +1,4 @@ + + + + diff --git a/doc/api-header.html b/doc/api-header.html new file mode 100644 index 000000000..91e7dc520 --- /dev/null +++ b/doc/api-header.html @@ -0,0 +1,41 @@ + + + + $title ($projectname) + + + + + +
+ + + + + + +
+ + +
+ + + + + +

TagLib 1.5 ($title)

+ +
+
+
+ +
diff --git a/doc/taglib-api.css b/doc/taglib-api.css new file mode 100644 index 000000000..d294b32f4 --- /dev/null +++ b/doc/taglib-api.css @@ -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 index 000000000..f31c0f153 --- /dev/null +++ b/doc/taglib.doxygen @@ -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 index 0000000000000000000000000000000000000000..7174ee9182cd107d60a8e5bb2227cf8de235b25b GIT binary patch literal 3451 zcmdT{do&Y_|K8?0i_C3vzq~5aQn`oJQgSb9mdMaTO{UCsY?BZY6}hHzd*2Kj(y}me zOS$*X-dL8)E76dw&Cu65zyE&!e1HG`KIc52=X}n2&gYNkkLR4{?pY5fc{vR^001EG ze8$mhhx>MrDl5IS3*@?!cS!OU()qmX&Jbm_NKy$%rSQyNXDKnTT=E!MxyL4zj4|;nRZ=Zn~ zPC4)5Uid=xa1nCG_`geOz*iD6 zKnVAiN~CFi51JTE#wzh6YJXh17jlj86i4^zoqKFo5Ux6t8? zscwQt&sydihH@M50A9pU=e$gh&3s-m!7V1|u`cpkOjpcN=X!wNts(U+xi4^DY{(^K z8zVI&r4>H$z|BQ?mv!oMV$-}5A?k)Z}Yd@gyO*7Jw4E$v9r!ktox zxk{hdntDtqj1&>o85*%!ei9BJ{r8EE$qKO)>)`WIOmQj8n7^q)#kzi#*#$a{QTNZ@ znvFTUqRF$zBtj!60b28eZ&zMnOjVY!%NdE#WXOK6p*g9Z_p1PzT;sB~S-X1+i zx9IEjW}V?FzyxV5QfA-pqynR&Lmk+|(8a_9-9L5jjp#Y|uY2r5Dlf?jR zVEi8~QXbnUD6@~=hfFW1%^I(cJoJnCVKjeB6_ro_A16)!Qf?)m=Ix>`S`Pg))uqu~ zO|Ks&vwBJ7le8O?Ptd16bD2|)@!M8`gz7sbyptQ4Al=KB4s%c@!^fR%*1geAJoyY=}+q7j1Med zud+Eb?0Y4v4Q^fPXZ5Tsb4`Q#zFC63>;M%PQ3&ddd{IT^VUxCf+;utJW-N$3rMs|H z&-gh7egn{gcM){hwFx?!B!r~E)ZlkLhWl1z{7Y#sW~O)#dOX~OeHIbD;P!0|$WMCr z(`fTdTCD71QC1aAwye7aF@O%R(E4*9QB(Yr9n3Aho4ay}wkplX~ko3?cCLX#>hig$u~{S^d7$q%j#XWN%GnP2UOC1I_A z4{5*R_Tcy84F#92Fv*kS2}uXp1NQIi$1*N_O`&d9=XOc4;UyIC7wr(HwDPPW4nxvK z?X?Z^XEvNgv^(#1_*JUiRy4ivI55JH*>RV<7)q?9*$*>8Nsx1)$fxjQ>J>iUAfr%U zrZv%``=Q0T5hbuPb9_YT^5w0Z@IY#ImYLZI@|hyEe_hJv@wD_fGD>P73h!Ux2a1y| zPF8-d@z3N4c}}VC#Sszo`3s}R#|2UcyVzFJ4<@cP0E%VG?hFL9XS-88_L1rm%$xhQ zZ>m}vwGI0_WV>4pc3yqxOL@oohl7Mumen~e-F`PO={FF?lV3*Vo8bhq?ftpkkJ~dT zWj0ejRkNn=UkzQk`4A`*t5G|!Bx5@qMT3pM5Dm_+oMR_9c>9d)#+igU8jeOp@AHGdwrad_2Xvh==O zr{`*?u-AGhM)S4H=cT%0?mBK+ed<@utU##p|Di;xHdajRjA@)w3g|jXfY3VD=r%dH%=Fzo5x$j@rGH^GJX0aH;sl>IH(-c9M3%(6%gpN{5CyL=v*FX+bQ)>b3XyUsZ<^1GFSJGS zms6Tl-n#M?fiDenT*l-%y4H%;03nFhXsbbM`)$k8zyMLN9gI37B=CC=sla843SZL( zT3T-pSXL$u41SG8H5Ud+FWj--Wi1V-%n=Zl-AqMB>#ndRCBqyo2|6WAZR_v|Agh-x zmEGHt6lMG8y9iAXgIYpw~UY5o-NJ`2L> zylA#JE0<;Xl$mg29|nqovSp671e@J(supe|*zF`;4irwlmv=1}iXNx#rm31V`qS)0 zT2hl~;3}oezf@0x-qF=K4+W3_OpWLjMwRp+Bm$7#b-8UQ>QiPg^iaM)wIcVEY9F7I z(s_ldnP;w|+?VImc^0!De{Nq@{T1_p;+d19-Cx#jW`qy%;;neq#zXE^J-$N*XbGZ} z&|VZU@|tCDJam6K%P~(m@x-Sw`9%-yWJ0+HcSMs@lfDw*POp{OzECHLf_h2}VJ8#d z))qAR&X(XWsL~gwK<`EX9{?Ub8zb6#-1QYl3&hKe&$Ke~aI@OFJ#;$N}>LsgvU=PDHID2p0L}d!()dLB?I|#+SOVX346QJ7;Gzme% zqnt~&w)&ONP19G8e6PmNW5!;((ic9gvZRaydxILSo!jFPhoB6zSUw!LHDlwZ^$xa3 zz~zqa^Ybz8LgN5$5R>lMB!;;PL;8LBkQT1p&t0Dae;iyhecNuLqiL#l-3Tu!nv1q> z_MeTJm5hQl+pPM`{!Ychc-Q%FR2jR($tmr#5RxJ)y|H;Ujy(71U``|_;#v_s+)ASF zw@dO?=c*d6i23hX*!x)d3D+oX5fk4bz37QST7S~6mm0!(ivOM|WGPawufuTH`!#TP zw&wYtD=Q*Sg13CksfAbV>w=eKSg=xo4Ks%L)Yjv2_lX(KZF0;uk?BPJC^{UaHb2VK0Fb zU6@Fdo?S$bAFlZ@8fr+wjTirHIXl0((JXE1mw1|S`ss2rHq)4s5Ssc!)^YZh0{#Fh zuHmaxNop-G4W#b9AemuQChHiS(~k#QJ_(b!+|hzsq}^a=bDol{MF>piE?$R+bEQ$b zq?h`G*V{*VYy9+8XtTx4HC&|Ed9czMEF83yw)ML%kOOF|xBW)1f9H!6TvHWDP@70S zdM$8p#SvUj)w#zp1f*kFXpzr