From 3ec5e27f8dc3616dd96c004fd7f10c7367805fc6 Mon Sep 17 00:00:00 2001 From: Juan RP Date: Thu, 27 Jan 2011 13:28:06 +0100 Subject: [PATCH] Update doxygen's doxyfile for the API, add the XBPS logo. --- doc/xbps-logo.png | Bin 0 -> 2222 bytes doc/xbps_api_doxyfile | 189 +++++++++++++++++++++++++++++------------- 2 files changed, 130 insertions(+), 59 deletions(-) create mode 100644 doc/xbps-logo.png diff --git a/doc/xbps-logo.png b/doc/xbps-logo.png new file mode 100644 index 0000000000000000000000000000000000000000..86126fb0aa57cdcb81201405ca08a8915008b6cf GIT binary patch literal 2222 zcmV;f2vPTmP)O-LPA6vzLs?WQ4g5f@sC8>6_iG=yfM&_JR10a=zB71{<` z2tpx?E??Xh+$5VOV4*%kQc4$si76NoXcq>XQg;zeHcIj~x^UB#OcyivzH`rez7U3J}-DOCRc=W^EO6Q^$o%3Iu)a;*BU+g|bse zc`^zW_ejs4R;>W4^OgEnCOx;b5LL%{G9d1e)bYlXH)80c=RbJehl$=*zYQ#8$SY)N zxlTO^cQZK{5PGj$7q%L*QK&h23zs&J(n!Kx0M^;^;>nWoA$7d*$SiK$>u!nMf zo@AS@)4jU93e5Hx*O5G7QX8fA-XLAFeSsrQWb!EiYYD7 zsv==-a~MDbK^=DJgxlLr3K3x(fMmd8xoASa^H6ML=E){{_hNu>(C&tjlQ@Sv*orsKR(vS z%j0)#U2Cbld$NruZ;Z)s@n}GN0_pd;f|>4y+QtD>w(0exw%OWu>%x}yd;k!Xhk)DR z>(czTbGzzE5h!4`RE64`S(`=$%g$|Sg}it&?uHxnXfA4WnJ+j3urLHH4B>F`*noh0 znk3oU9h8Rv0EdgmI9xogeURdH>j|}z2cvfQ4okb_EnKz=G^-a|swM(v3p4#IliGs; zAp~9fyV_QOI6L{rl%h3|GR5kLjwDlwf*UL-Ma>PFjFrr|l8>QL!C4(cN^npX$D7;ZymEBNl z`cwn1^HT^WpXt%e>fk{)!TV5S>b`__1G{PdmMqh zYo3q5X?#Bt&B2V%$PFRdCU(W@Gum#l^^2zv=cmf}d$0x;$;DAFrb5IT40Sd5Plu9)q^>-G83Ncb;OkQW=u-E{j?XUsHflyGty1Z&siZ_4T$IXQy zh~Y88URHnsZHA1lJ_G75-6DX6@6r9k?+5LkAvVA)%mKAY4Q9G!2o~h?wHipAc^f6W z8eB))bDP6Pjwag80boEIAya_SPzk^QOiA6je6w0yk0L6~Z{y(XfIilM1v_SVbbtU$ z)o`*LAyC&4F@pb$fH5Od(VGm;@LN0W{&J zxs^Jn_PPBIuH0M4%-S@%_IC}?0GQ!11ypLU9w|EqivyzF%Gh!uu*%y=`-{K-G#|dO zRm+z4X6?b0GKGwXN2M5G3qw)0wT+<6PQD&hVF`CIm$+P^bFbEUFQW}n4rzln$#Vg5 zxVXo+6(o5B49Kv$q=P1TFzUUeitFI)Ky6J5?m0+oa^Mgi9X%JXE@>Dv+VJIP`n3xH zYOK2YrZIjex$Sue49Lin*&Zoz1x$%ohb~DjtppVmYEA0k?0}OEB`H60Rgz6AYM%nu z=#9~Cz<@R+{(QZM17?WjR#v6JVUuLD-ihMtUXomGO5UF4lh&mV0kAy4rQ{tlY2ac{ z1V{-i892J|8B-mARmPT$&}DpP$-QiorP_12cx;66G}SZt95C0SBu{_=o*}d4VF2*U znIAARJZfK2w=6~)N&w83K)ZUoR!vkhcGA4JbYtWVFu)^ZX^H;G@ThTq;($hyJW*OG zN?Hn#l$%LXRq||)_i|?>wlj+e#zrR{4#VJPqXUU-%Wkmp zDr3tX1sKr!9Py;f>jrrv`+S`=Ikx_FQXjIA_op!G0j-#vlc^K^XKxDSLmlce?Hq)$ literal 0 HcmV?d00001 diff --git a/doc/xbps_api_doxyfile b/doc/xbps_api_doxyfile index 25ae053a..afd2de6b 100644 --- a/doc/xbps_api_doxyfile +++ b/doc/xbps_api_doxyfile @@ -1,6 +1,13 @@ +# Doxyfile 1.7.3 + +#--------------------------------------------------------------------------- +# Project related configuration options +#--------------------------------------------------------------------------- DOXYFILE_ENCODING = UTF-8 -PROJECT_NAME = "The X Binary Package System Library API" -PROJECT_NUMBER = 20100119 +PROJECT_NAME = "XBPS Library API" +PROJECT_NUMBER = 20110126 +PROJECT_BRIEF = "The X Binary Package System" +PROJECT_LOGO = xbps-logo.png OUTPUT_DIRECTORY = ../api CREATE_SUBDIRS = YES OUTPUT_LANGUAGE = English @@ -19,30 +26,33 @@ ABBREVIATE_BRIEF = "The $name class" \ the ALWAYS_DETAILED_SEC = YES INLINE_INHERITED_MEMB = NO -FULL_PATH_NAMES = YES -STRIP_FROM_PATH = -STRIP_FROM_INC_PATH = +FULL_PATH_NAMES = NO +STRIP_FROM_PATH = +STRIP_FROM_INC_PATH = SHORT_NAMES = NO -JAVADOC_AUTOBRIEF = NO +JAVADOC_AUTOBRIEF = YES QT_AUTOBRIEF = NO MULTILINE_CPP_IS_BRIEF = NO INHERIT_DOCS = YES SEPARATE_MEMBER_PAGES = NO TAB_SIZE = 8 -ALIASES = +ALIASES = OPTIMIZE_OUTPUT_FOR_C = YES OPTIMIZE_OUTPUT_JAVA = NO OPTIMIZE_FOR_FORTRAN = NO OPTIMIZE_OUTPUT_VHDL = NO -EXTENSION_MAPPING = +EXTENSION_MAPPING = BUILTIN_STL_SUPPORT = NO CPP_CLI_SUPPORT = NO SIP_SUPPORT = NO IDL_PROPERTY_SUPPORT = YES -DISTRIBUTE_GROUP_DOC = NO +DISTRIBUTE_GROUP_DOC = YES SUBGROUPING = YES TYPEDEF_HIDES_STRUCT = YES SYMBOL_CACHE_SIZE = 0 +#--------------------------------------------------------------------------- +# Build related configuration options +#--------------------------------------------------------------------------- EXTRACT_ALL = NO EXTRACT_PRIVATE = NO EXTRACT_STATIC = NO @@ -64,80 +74,108 @@ SORT_BRIEF_DOCS = YES SORT_MEMBERS_CTORS_1ST = NO SORT_GROUP_NAMES = YES SORT_BY_SCOPE_NAME = NO +STRICT_PROTO_MATCHING = NO GENERATE_TODOLIST = YES GENERATE_TESTLIST = YES GENERATE_BUGLIST = YES GENERATE_DEPRECATEDLIST= YES -ENABLED_SECTIONS = +ENABLED_SECTIONS = MAX_INITIALIZER_LINES = 30 SHOW_USED_FILES = YES SHOW_DIRECTORIES = NO SHOW_FILES = YES SHOW_NAMESPACES = YES -FILE_VERSION_FILTER = -LAYOUT_FILE = +FILE_VERSION_FILTER = +LAYOUT_FILE = +#--------------------------------------------------------------------------- +# configuration options related to warning and progress messages +#--------------------------------------------------------------------------- QUIET = NO WARNINGS = YES WARN_IF_UNDOCUMENTED = YES WARN_IF_DOC_ERROR = YES WARN_NO_PARAMDOC = YES WARN_FORMAT = "$file:$line: $text" -WARN_LOGFILE = +WARN_LOGFILE = +#--------------------------------------------------------------------------- +# configuration options related to the input files +#--------------------------------------------------------------------------- INPUT = .. INPUT_ENCODING = UTF-8 -FILE_PATTERNS = *.c *.h +FILE_PATTERNS = *.c \ + *.h RECURSIVE = YES -EXCLUDE = ../.bzr ../bin ../lib/fetch \ - ../include/sha256.h ../include/fetch.h \ - ../lib/portableproplib +EXCLUDE = ../.hg \ + ../bin \ + ../lib/fetch \ + ../include/sha256.h \ + ../include/fetch.h \ + ../lib/portableproplib EXCLUDE_SYMLINKS = NO -EXCLUDE_PATTERNS = .bzr *.mk Makefile -EXCLUDE_SYMBOLS = -EXAMPLE_PATH = +EXCLUDE_PATTERNS = .hg \ + *.mk \ + Makefile +EXCLUDE_SYMBOLS = +EXAMPLE_PATH = EXAMPLE_PATTERNS = * EXAMPLE_RECURSIVE = NO IMAGE_PATH = images -INPUT_FILTER = -FILTER_PATTERNS = +INPUT_FILTER = +FILTER_PATTERNS = FILTER_SOURCE_FILES = NO +FILTER_SOURCE_PATTERNS = +#--------------------------------------------------------------------------- +# configuration options related to source browsing +#--------------------------------------------------------------------------- SOURCE_BROWSER = NO INLINE_SOURCES = NO -STRIP_CODE_COMMENTS = YES +STRIP_CODE_COMMENTS = NO REFERENCED_BY_RELATION = YES REFERENCES_RELATION = YES -REFERENCES_LINK_SOURCE = NO -USE_HTAGS = NO +REFERENCES_LINK_SOURCE = YES +USE_HTAGS = YES VERBATIM_HEADERS = NO -ALPHABETICAL_INDEX = NO +#--------------------------------------------------------------------------- +# configuration options related to the alphabetical class index +#--------------------------------------------------------------------------- +ALPHABETICAL_INDEX = YES COLS_IN_ALPHA_INDEX = 5 -IGNORE_PREFIX = +IGNORE_PREFIX = +#--------------------------------------------------------------------------- +# configuration options related to the HTML output +#--------------------------------------------------------------------------- GENERATE_HTML = YES HTML_OUTPUT = html HTML_FILE_EXTENSION = .html -HTML_HEADER = -HTML_FOOTER = -HTML_STYLESHEET = +HTML_HEADER = +HTML_FOOTER = +HTML_STYLESHEET = +HTML_COLORSTYLE_HUE = 220 +HTML_COLORSTYLE_SAT = 100 +HTML_COLORSTYLE_GAMMA = 80 HTML_TIMESTAMP = YES HTML_ALIGN_MEMBERS = NO -HTML_DYNAMIC_SECTIONS = NO -GENERATE_DOCSET = NO +HTML_DYNAMIC_SECTIONS = YES +GENERATE_DOCSET = YES DOCSET_FEEDNAME = "Doxygen generated docs" DOCSET_BUNDLE_ID = org.doxygen.Project -GENERATE_HTMLHELP = NO -CHM_FILE = -HHC_LOCATION = +DOCSET_PUBLISHER_ID = org.doxygen.Publisher +DOCSET_PUBLISHER_NAME = Publisher +GENERATE_HTMLHELP = YES +CHM_FILE = +HHC_LOCATION = GENERATE_CHI = NO -CHM_INDEX_ENCODING = -BINARY_TOC = NO -TOC_EXPAND = NO +CHM_INDEX_ENCODING = +BINARY_TOC = YES +TOC_EXPAND = YES GENERATE_QHP = NO -QCH_FILE = +QCH_FILE = QHP_NAMESPACE = org.doxygen.Project QHP_VIRTUAL_FOLDER = doc -QHP_CUST_FILTER_NAME = -QHP_CUST_FILTER_ATTRS = -QHP_SECT_FILTER_ATTRS = -QHG_LOCATION = +QHP_CUST_FILTER_NAME = +QHP_CUST_FILTER_ATTRS = +QHP_SECT_FILTER_ATTRS = +QHG_LOCATION = GENERATE_ECLIPSEHELP = NO ECLIPSE_DOC_ID = org.doxygen.Project DISABLE_INDEX = NO @@ -145,63 +183,95 @@ ENUM_VALUES_PER_LINE = 4 GENERATE_TREEVIEW = NO USE_INLINE_TREES = NO TREEVIEW_WIDTH = 250 +EXT_LINKS_IN_WINDOW = NO FORMULA_FONTSIZE = 10 +FORMULA_TRANSPARENT = YES +USE_MATHJAX = NO +MATHJAX_RELPATH = http://www.mathjax.org/mathjax SEARCHENGINE = YES SERVER_BASED_SEARCH = NO +#--------------------------------------------------------------------------- +# 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 = a4wide -EXTRA_PACKAGES = -LATEX_HEADER = +EXTRA_PACKAGES = +LATEX_HEADER = PDF_HYPERLINKS = YES USE_PDFLATEX = YES LATEX_BATCHMODE = NO LATEX_HIDE_INDICES = NO LATEX_SOURCE_CODE = 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 = +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 = +XML_SCHEMA = +XML_DTD = XML_PROGRAMLISTING = YES +#--------------------------------------------------------------------------- +# 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 = +PERLMOD_MAKEVAR_PREFIX = +#--------------------------------------------------------------------------- +# Configuration options related to the preprocessor +#--------------------------------------------------------------------------- ENABLE_PREPROCESSING = YES MACRO_EXPANSION = YES EXPAND_ONLY_PREDEF = YES SEARCH_INCLUDES = YES -INCLUDE_PATH = -INCLUDE_FILE_PATTERNS = +INCLUDE_PATH = +INCLUDE_FILE_PATTERNS = PREDEFINED = SIMPLEQ_ENTRY EXPAND_AS_DEFINED = SKIP_FUNCTION_MACROS = YES -TAGFILES = -GENERATE_TAGFILE = +#--------------------------------------------------------------------------- +# Configuration::additions 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 -MSCGEN_PATH = +MSCGEN_PATH = HIDE_UNDOC_RELATIONS = YES HAVE_DOT = YES +DOT_NUM_THREADS = 0 DOT_FONTNAME = DejaVuSansCondensed -DOT_FONTSIZE = 6 -DOT_FONTPATH = +DOT_FONTSIZE = 8 +DOT_FONTPATH = CLASS_GRAPH = YES COLLABORATION_GRAPH = YES GROUP_GRAPHS = YES @@ -214,8 +284,9 @@ CALLER_GRAPH = YES GRAPHICAL_HIERARCHY = YES DIRECTORY_GRAPH = YES DOT_IMAGE_FORMAT = png -DOT_PATH = -DOTFILE_DIRS = +DOT_PATH = +DOTFILE_DIRS = +MSCFILE_DIRS = DOT_GRAPH_MAX_NODES = 50 MAX_DOT_GRAPH_DEPTH = 0 DOT_TRANSPARENT = YES