moparisthebest/pacman
1
0
Fork 0
mirror of https://github.com/moparisthebest/pacman synced 2024-10-31 23:55:04 -04:00
Code Issues Releases Wiki Activity
f4ecc908ec
pacman/doc/Doxyfile

252 lines
9.1 KiB
Plaintext
Raw Normal View History

Update Doxyfile with some new options in new version Signed-off-by: Dan McGee <dan@archlinux.org>
2008-02-14 12:33:45 -05:00
# Doxyfile 1.5.5
added Doxyfile
2005-11-21 17:14:32 -05:00
#---------------------------------------------------------------------------
# Project related configuration options
#---------------------------------------------------------------------------
Update Doxyfile for v1.5.2 Ran a doxygen -s -u as recommended on the Doxyfile. Signed-off-by: Dan McGee <dan@archlinux.org>
2007-04-25 10:24:50 -04:00
DOXYFILE_ENCODING = UTF-8
added Doxyfile
2005-11-21 17:14:32 -05:00
PROJECT_NAME = libalpm
PROJECT_NUMBER =
Move Doxygen manpage generation to doc/ directory Instead of doing the doxygen work in the libalpm/ dir, do it with the rest of the docs in the doc/ dir. Signed-off-by: Dan McGee <dan@archlinux.org>
2007-07-01 18:40:43 -04:00
OUTPUT_DIRECTORY = ./
added Doxyfile
2005-11-21 17:14:32 -05:00
CREATE_SUBDIRS = NO
OUTPUT_LANGUAGE = English
BRIEF_MEMBER_DESC = YES
REPEAT_BRIEF = YES
ABBREVIATE_BRIEF = "The $name class" \
"The $name widget" \
"The $name file" \
is \
provides \
specifies \
contains \
represents \
a \
an \
the
Doxygen fixups for libalpm We haven't done a whole lot with Doxygen so far, so this updates some of the things that have changed a lot- namely, the now public exposure of alpm_list. All functions in this file have now been Doxygen commented, and a few other things in alpm.c were fixed as well. In addition, the Doxygen config file was updated. Signed-off-by: Dan McGee <dan@archlinux.org>
2007-03-29 00:40:49 -04:00
ALWAYS_DETAILED_SEC = YES
added Doxyfile
2005-11-21 17:14:32 -05:00
INLINE_INHERITED_MEMB = NO
Updates to fix Doxygen documentation generation We had way too much going on with the Doxygen manpage generation. Clean it up quite a bit by removing directory manpages, using relative paths, not having a manpage for every single alpm function, and ensuring internal functions are not documented publicly. Signed-off-by: Dan McGee <dan@archlinux.org>
2007-10-14 18:29:32 -04:00
FULL_PATH_NAMES = NO
added Doxyfile
2005-11-21 17:14:32 -05:00
STRIP_FROM_PATH =
STRIP_FROM_INC_PATH =
SHORT_NAMES = NO
Doxyfile : enable JAVADOC_AUTOBRIEF. From http://www.stack.nl/~dimitri/doxygen/config.html#cfg_javadoc_autobrief JAVADOC_AUTOBRIEF If the JAVADOC_AUTOBRIEF is set to YES then doxygen will interpret the first line (until the first dot) of a JavaDoc-style comment as the brief description. If set to NO (the default), the Javadoc-style will behave just like regular Qt-style comments (thus requiring an explicit @brief command for a brief description.) Signed-off-by: Chantry Xavier <shiningxc@gmail.com> Signed-off-by: Dan McGee <dan@archlinux.org>
2008-04-29 15:30:28 -04:00
JAVADOC_AUTOBRIEF = YES
Update Doxyfile with some new options in new version Signed-off-by: Dan McGee <dan@archlinux.org>
2008-02-14 12:33:45 -05:00
QT_AUTOBRIEF = NO
added Doxyfile
2005-11-21 17:14:32 -05:00
MULTILINE_CPP_IS_BRIEF = NO
DETAILS_AT_TOP = NO
INHERIT_DOCS = YES
SEPARATE_MEMBER_PAGES = NO
Doxygen fixups for libalpm We haven't done a whole lot with Doxygen so far, so this updates some of the things that have changed a lot- namely, the now public exposure of alpm_list. All functions in this file have now been Doxygen commented, and a few other things in alpm.c were fixed as well. In addition, the Doxygen config file was updated. Signed-off-by: Dan McGee <dan@archlinux.org>
2007-03-29 00:40:49 -04:00
TAB_SIZE = 4
added Doxyfile
2005-11-21 17:14:32 -05:00
ALIASES =
OPTIMIZE_OUTPUT_FOR_C = YES
OPTIMIZE_OUTPUT_JAVA = NO
Update Doxyfile with some new options in new version Signed-off-by: Dan McGee <dan@archlinux.org>
2008-02-14 12:33:45 -05:00
OPTIMIZE_FOR_FORTRAN = NO
OPTIMIZE_OUTPUT_VHDL = NO
added Doxyfile
2005-11-21 17:14:32 -05:00
BUILTIN_STL_SUPPORT = NO
Update Doxyfile for v1.5.2 Ran a doxygen -s -u as recommended on the Doxyfile. Signed-off-by: Dan McGee <dan@archlinux.org>
2007-04-25 10:24:50 -04:00
CPP_CLI_SUPPORT = NO
Update Doxyfile with some new options in new version Signed-off-by: Dan McGee <dan@archlinux.org>
2008-02-14 12:33:45 -05:00
SIP_SUPPORT = NO
added Doxyfile
2005-11-21 17:14:32 -05:00
DISTRIBUTE_GROUP_DOC = NO
SUBGROUPING = YES
Update Doxyfile with some new options in new version Signed-off-by: Dan McGee <dan@archlinux.org>
2008-02-14 12:33:45 -05:00
TYPEDEF_HIDES_STRUCT = NO
added Doxyfile
2005-11-21 17:14:32 -05:00
#---------------------------------------------------------------------------
# Build related configuration options
#---------------------------------------------------------------------------
EXTRACT_ALL = NO
EXTRACT_PRIVATE = NO
EXTRACT_STATIC = NO
EXTRACT_LOCAL_CLASSES = YES
EXTRACT_LOCAL_METHODS = NO
Update Doxyfile with some new options in new version Signed-off-by: Dan McGee <dan@archlinux.org>
2008-02-14 12:33:45 -05:00
EXTRACT_ANON_NSPACES = NO
Doxygen fixups for libalpm We haven't done a whole lot with Doxygen so far, so this updates some of the things that have changed a lot- namely, the now public exposure of alpm_list. All functions in this file have now been Doxygen commented, and a few other things in alpm.c were fixed as well. In addition, the Doxygen config file was updated. Signed-off-by: Dan McGee <dan@archlinux.org>
2007-03-29 00:40:49 -04:00
HIDE_UNDOC_MEMBERS = NO
HIDE_UNDOC_CLASSES = NO
added Doxyfile
2005-11-21 17:14:32 -05:00
HIDE_FRIEND_COMPOUNDS = NO
Doxygen fixups for libalpm We haven't done a whole lot with Doxygen so far, so this updates some of the things that have changed a lot- namely, the now public exposure of alpm_list. All functions in this file have now been Doxygen commented, and a few other things in alpm.c were fixed as well. In addition, the Doxygen config file was updated. Signed-off-by: Dan McGee <dan@archlinux.org>
2007-03-29 00:40:49 -04:00
HIDE_IN_BODY_DOCS = YES
added Doxyfile
2005-11-21 17:14:32 -05:00
INTERNAL_DOCS = NO
CASE_SENSE_NAMES = YES
HIDE_SCOPE_NAMES = NO
SHOW_INCLUDE_FILES = YES
INLINE_INFO = YES
SORT_MEMBER_DOCS = YES
SORT_BRIEF_DOCS = NO
Update Doxyfile with some new options in new version Signed-off-by: Dan McGee <dan@archlinux.org>
2008-02-14 12:33:45 -05:00
SORT_GROUP_NAMES = NO
added Doxyfile
2005-11-21 17:14:32 -05:00
SORT_BY_SCOPE_NAME = NO
GENERATE_TODOLIST = YES
GENERATE_TESTLIST = YES
GENERATE_BUGLIST = YES
GENERATE_DEPRECATEDLIST= YES
ENABLED_SECTIONS =
MAX_INITIALIZER_LINES = 30
SHOW_USED_FILES = YES
Updates to fix Doxygen documentation generation We had way too much going on with the Doxygen manpage generation. Clean it up quite a bit by removing directory manpages, using relative paths, not having a manpage for every single alpm function, and ensuring internal functions are not documented publicly. Signed-off-by: Dan McGee <dan@archlinux.org>
2007-10-14 18:29:32 -04:00
SHOW_DIRECTORIES = NO
added Doxyfile
2005-11-21 17:14:32 -05:00
FILE_VERSION_FILTER =
#---------------------------------------------------------------------------
# configuration options related to warning and progress messages
#---------------------------------------------------------------------------
QUIET = NO
WARNINGS = YES
WARN_IF_UNDOCUMENTED = YES
WARN_IF_DOC_ERROR = YES
WARN_NO_PARAMDOC = NO
WARN_FORMAT = "$file:$line: $text"
WARN_LOGFILE =
#---------------------------------------------------------------------------
# configuration options related to the input files
#---------------------------------------------------------------------------
Move Doxygen manpage generation to doc/ directory Instead of doing the doxygen work in the libalpm/ dir, do it with the rest of the docs in the doc/ dir. Signed-off-by: Dan McGee <dan@archlinux.org>
2007-07-01 18:40:43 -04:00
INPUT = ../lib/libalpm/
Update Doxyfile for v1.5.2 Ran a doxygen -s -u as recommended on the Doxyfile. Signed-off-by: Dan McGee <dan@archlinux.org>
2007-04-25 10:24:50 -04:00
INPUT_ENCODING = UTF-8
Doxygen fixups for libalpm We haven't done a whole lot with Doxygen so far, so this updates some of the things that have changed a lot- namely, the now public exposure of alpm_list. All functions in this file have now been Doxygen commented, and a few other things in alpm.c were fixed as well. In addition, the Doxygen config file was updated. Signed-off-by: Dan McGee <dan@archlinux.org>
2007-03-29 00:40:49 -04:00
FILE_PATTERNS =
added Doxyfile
2005-11-21 17:14:32 -05:00
RECURSIVE = NO
EXCLUDE =
EXCLUDE_SYMLINKS = NO
EXCLUDE_PATTERNS =
Move Doxygen manpage generation to doc/ directory Instead of doing the doxygen work in the libalpm/ dir, do it with the rest of the docs in the doc/ dir. Signed-off-by: Dan McGee <dan@archlinux.org>
2007-07-01 18:40:43 -04:00
EXCLUDE_SYMBOLS =
added Doxyfile
2005-11-21 17:14:32 -05:00
EXAMPLE_PATH =
EXAMPLE_PATTERNS = *
EXAMPLE_RECURSIVE = NO
IMAGE_PATH =
INPUT_FILTER =
FILTER_PATTERNS =
FILTER_SOURCE_FILES = NO
#---------------------------------------------------------------------------
# configuration options related to source browsing
#---------------------------------------------------------------------------
SOURCE_BROWSER = NO
Doxygen fixups for libalpm We haven't done a whole lot with Doxygen so far, so this updates some of the things that have changed a lot- namely, the now public exposure of alpm_list. All functions in this file have now been Doxygen commented, and a few other things in alpm.c were fixed as well. In addition, the Doxygen config file was updated. Signed-off-by: Dan McGee <dan@archlinux.org>
2007-03-29 00:40:49 -04:00
INLINE_SOURCES = NO
STRIP_CODE_COMMENTS = NO
REFERENCED_BY_RELATION = YES
REFERENCES_RELATION = YES
REFERENCES_LINK_SOURCE = YES
USE_HTAGS = NO
VERBATIM_HEADERS = YES
added Doxyfile
2005-11-21 17:14:32 -05:00
#---------------------------------------------------------------------------
# configuration options related to the alphabetical class index
#---------------------------------------------------------------------------
ALPHABETICAL_INDEX = NO
Doxygen fixups for libalpm We haven't done a whole lot with Doxygen so far, so this updates some of the things that have changed a lot- namely, the now public exposure of alpm_list. All functions in this file have now been Doxygen commented, and a few other things in alpm.c were fixed as well. In addition, the Doxygen config file was updated. Signed-off-by: Dan McGee <dan@archlinux.org>
2007-03-29 00:40:49 -04:00
COLS_IN_ALPHA_INDEX = 5
IGNORE_PREFIX =
added Doxyfile
2005-11-21 17:14:32 -05:00
#---------------------------------------------------------------------------
# configuration options related to the HTML output
#---------------------------------------------------------------------------
GENERATE_HTML = NO
Doxygen fixups for libalpm We haven't done a whole lot with Doxygen so far, so this updates some of the things that have changed a lot- namely, the now public exposure of alpm_list. All functions in this file have now been Doxygen commented, and a few other things in alpm.c were fixed as well. In addition, the Doxygen config file was updated. Signed-off-by: Dan McGee <dan@archlinux.org>
2007-03-29 00:40:49 -04:00
HTML_OUTPUT = html
HTML_FILE_EXTENSION = .html
HTML_HEADER =
HTML_FOOTER =
HTML_STYLESHEET =
HTML_ALIGN_MEMBERS = YES
GENERATE_HTMLHELP = NO
Update Doxyfile with some new options in new version Signed-off-by: Dan McGee <dan@archlinux.org>
2008-02-14 12:33:45 -05:00
GENERATE_DOCSET = NO
DOCSET_FEEDNAME = "Doxygen generated docs"
DOCSET_BUNDLE_ID = org.doxygen.Project
HTML_DYNAMIC_SECTIONS = NO
Doxygen fixups for libalpm We haven't done a whole lot with Doxygen so far, so this updates some of the things that have changed a lot- namely, the now public exposure of alpm_list. All functions in this file have now been Doxygen commented, and a few other things in alpm.c were fixed as well. In addition, the Doxygen config file was updated. Signed-off-by: Dan McGee <dan@archlinux.org>
2007-03-29 00:40:49 -04:00
CHM_FILE =
HHC_LOCATION =
GENERATE_CHI = NO
BINARY_TOC = NO
TOC_EXPAND = NO
DISABLE_INDEX = NO
ENUM_VALUES_PER_LINE = 4
GENERATE_TREEVIEW = NO
TREEVIEW_WIDTH = 250
added Doxyfile
2005-11-21 17:14:32 -05:00
#---------------------------------------------------------------------------
# configuration options related to the LaTeX output
#---------------------------------------------------------------------------
GENERATE_LATEX = NO
Doxygen fixups for libalpm We haven't done a whole lot with Doxygen so far, so this updates some of the things that have changed a lot- namely, the now public exposure of alpm_list. All functions in this file have now been Doxygen commented, and a few other things in alpm.c were fixed as well. In addition, the Doxygen config file was updated. Signed-off-by: Dan McGee <dan@archlinux.org>
2007-03-29 00:40:49 -04:00
LATEX_OUTPUT = latex
LATEX_CMD_NAME = latex
MAKEINDEX_CMD_NAME = makeindex
COMPACT_LATEX = NO
PAPER_TYPE = a4wide
EXTRA_PACKAGES =
LATEX_HEADER =
PDF_HYPERLINKS = NO
USE_PDFLATEX = NO
LATEX_BATCHMODE = NO
LATEX_HIDE_INDICES = NO
added Doxyfile
2005-11-21 17:14:32 -05:00
#---------------------------------------------------------------------------
# configuration options related to the RTF output
#---------------------------------------------------------------------------
GENERATE_RTF = NO
Doxygen fixups for libalpm We haven't done a whole lot with Doxygen so far, so this updates some of the things that have changed a lot- namely, the now public exposure of alpm_list. All functions in this file have now been Doxygen commented, and a few other things in alpm.c were fixed as well. In addition, the Doxygen config file was updated. Signed-off-by: Dan McGee <dan@archlinux.org>
2007-03-29 00:40:49 -04:00
RTF_OUTPUT = rtf
COMPACT_RTF = NO
RTF_HYPERLINKS = NO
RTF_STYLESHEET_FILE =
RTF_EXTENSIONS_FILE =
added Doxyfile
2005-11-21 17:14:32 -05:00
#---------------------------------------------------------------------------
# configuration options related to the man page output
#---------------------------------------------------------------------------
GENERATE_MAN = YES
Doxygen fixups for libalpm We haven't done a whole lot with Doxygen so far, so this updates some of the things that have changed a lot- namely, the now public exposure of alpm_list. All functions in this file have now been Doxygen commented, and a few other things in alpm.c were fixed as well. In addition, the Doxygen config file was updated. Signed-off-by: Dan McGee <dan@archlinux.org>
2007-03-29 00:40:49 -04:00
MAN_OUTPUT = .
added Doxyfile
2005-11-21 17:14:32 -05:00
MAN_EXTENSION = .3
Updates to fix Doxygen documentation generation We had way too much going on with the Doxygen manpage generation. Clean it up quite a bit by removing directory manpages, using relative paths, not having a manpage for every single alpm function, and ensuring internal functions are not documented publicly. Signed-off-by: Dan McGee <dan@archlinux.org>
2007-10-14 18:29:32 -04:00
MAN_LINKS = NO
added Doxyfile
2005-11-21 17:14:32 -05:00
#---------------------------------------------------------------------------
# configuration options related to the XML output
#---------------------------------------------------------------------------
GENERATE_XML = NO
Doxygen fixups for libalpm We haven't done a whole lot with Doxygen so far, so this updates some of the things that have changed a lot- namely, the now public exposure of alpm_list. All functions in this file have now been Doxygen commented, and a few other things in alpm.c were fixed as well. In addition, the Doxygen config file was updated. Signed-off-by: Dan McGee <dan@archlinux.org>
2007-03-29 00:40:49 -04:00
XML_OUTPUT = xml
XML_SCHEMA =
XML_DTD =
XML_PROGRAMLISTING = YES
#---------------------------------------------------------------------------
# configuration options for the AutoGen Definitions output
#---------------------------------------------------------------------------
GENERATE_AUTOGEN_DEF = NO
added Doxyfile
2005-11-21 17:14:32 -05:00
#---------------------------------------------------------------------------
# configuration options related to the Perl module output
#---------------------------------------------------------------------------
GENERATE_PERLMOD = NO
Doxygen fixups for libalpm We haven't done a whole lot with Doxygen so far, so this updates some of the things that have changed a lot- namely, the now public exposure of alpm_list. All functions in this file have now been Doxygen commented, and a few other things in alpm.c were fixed as well. In addition, the Doxygen config file was updated. Signed-off-by: Dan McGee <dan@archlinux.org>
2007-03-29 00:40:49 -04:00
PERLMOD_LATEX = NO
PERLMOD_PRETTY = YES
PERLMOD_MAKEVAR_PREFIX =
added Doxyfile
2005-11-21 17:14:32 -05:00
#---------------------------------------------------------------------------
# Configuration options related to the preprocessor
#---------------------------------------------------------------------------
ENABLE_PREPROCESSING = YES
doxygen: preprocess SYMHIDDEN/SYMEXPORT macros so they don't show in docs Signed-off-by: Dan McGee <dan@archlinux.org>
2007-10-29 08:13:58 -04:00
MACRO_EXPANSION = YES
EXPAND_ONLY_PREDEF = YES
added Doxyfile
2005-11-21 17:14:32 -05:00
SEARCH_INCLUDES = YES
Doxygen fixups for libalpm We haven't done a whole lot with Doxygen so far, so this updates some of the things that have changed a lot- namely, the now public exposure of alpm_list. All functions in this file have now been Doxygen commented, and a few other things in alpm.c were fixed as well. In addition, the Doxygen config file was updated. Signed-off-by: Dan McGee <dan@archlinux.org>
2007-03-29 00:40:49 -04:00
INCLUDE_PATH = ../..
INCLUDE_FILE_PATTERNS = *.h
Update Doxyfile with some new options in new version Signed-off-by: Dan McGee <dan@archlinux.org>
2008-02-14 12:33:45 -05:00
PREDEFINED = HAVE_CONFIG_H= \
SYMHIDDEN= \
SYMEXPORT=
added Doxyfile
2005-11-21 17:14:32 -05:00
EXPAND_AS_DEFINED =
SKIP_FUNCTION_MACROS = YES
#---------------------------------------------------------------------------
Doxygen fixups for libalpm We haven't done a whole lot with Doxygen so far, so this updates some of the things that have changed a lot- namely, the now public exposure of alpm_list. All functions in this file have now been Doxygen commented, and a few other things in alpm.c were fixed as well. In addition, the Doxygen config file was updated. Signed-off-by: Dan McGee <dan@archlinux.org>
2007-03-29 00:40:49 -04:00
# Configuration::additions related to external references
#---------------------------------------------------------------------------
TAGFILES =
GENERATE_TAGFILE =
ALLEXTERNALS = NO
EXTERNAL_GROUPS = YES
PERL_PATH = /usr/bin/perl
#---------------------------------------------------------------------------
added Doxyfile
2005-11-21 17:14:32 -05:00
# Configuration options related to the dot tool
#---------------------------------------------------------------------------
CLASS_DIAGRAMS = NO
Move Doxygen manpage generation to doc/ directory Instead of doing the doxygen work in the libalpm/ dir, do it with the rest of the docs in the doc/ dir. Signed-off-by: Dan McGee <dan@archlinux.org>
2007-07-01 18:40:43 -04:00
MSCGEN_PATH =
Doxygen fixups for libalpm We haven't done a whole lot with Doxygen so far, so this updates some of the things that have changed a lot- namely, the now public exposure of alpm_list. All functions in this file have now been Doxygen commented, and a few other things in alpm.c were fixed as well. In addition, the Doxygen config file was updated. Signed-off-by: Dan McGee <dan@archlinux.org>
2007-03-29 00:40:49 -04:00
HIDE_UNDOC_RELATIONS = YES
HAVE_DOT = YES
CLASS_GRAPH = YES
COLLABORATION_GRAPH = YES
GROUP_GRAPHS = YES
UML_LOOK = NO
TEMPLATE_RELATIONS = NO
INCLUDE_GRAPH = YES
INCLUDED_BY_GRAPH = YES
CALL_GRAPH = NO
CALLER_GRAPH = NO
GRAPHICAL_HIERARCHY = YES
DIRECTORY_GRAPH = YES
DOT_IMAGE_FORMAT = png
DOT_PATH =
DOTFILE_DIRS =
Update Doxyfile for v1.5.2 Ran a doxygen -s -u as recommended on the Doxyfile. Signed-off-by: Dan McGee <dan@archlinux.org>
2007-04-25 10:24:50 -04:00
DOT_GRAPH_MAX_NODES = 50
Update Doxyfile with some new options in new version Signed-off-by: Dan McGee <dan@archlinux.org>
2008-02-14 12:33:45 -05:00
MAX_DOT_GRAPH_DEPTH = 3
Doxygen fixups for libalpm We haven't done a whole lot with Doxygen so far, so this updates some of the things that have changed a lot- namely, the now public exposure of alpm_list. All functions in this file have now been Doxygen commented, and a few other things in alpm.c were fixed as well. In addition, the Doxygen config file was updated. Signed-off-by: Dan McGee <dan@archlinux.org>
2007-03-29 00:40:49 -04:00
DOT_TRANSPARENT = NO
DOT_MULTI_TARGETS = NO
GENERATE_LEGEND = YES
DOT_CLEANUP = YES
#---------------------------------------------------------------------------
# Configuration::additions related to the search engine
#---------------------------------------------------------------------------
SEARCHENGINE = NO
Reference in New Issue Copy Permalink