ogame-opensource/Doxyfile at master · ogamespec/ogame-opensource · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
# Doxyfile for OGame Open Source

# sudo apt-get install doxygen
# sudo apt-get install texlive-full
# doxygen Doxyfile
# cd latex/
# make

# Project name
PROJECT_NAME           = "OGame Open Source Core API"
PROJECT_NUMBER         = 1.0.0
PROJECT_BRIEF          = "Core API Documentation"
PROJECT_LOGO           =

# Source code files
INPUT                  = game/core
FILE_PATTERNS          = *.php
RECURSIVE              = YES
EXCLUDE                =
EXCLUDE_PATTERNS       = */test/* */vendor/*
EXCLUDE_SYMLINKS       = NO

# Source code parser
ENABLE_PREPROCESSING   = YES
MACRO_EXPANSION        = YES
EXPAND_ONLY_PREDEF     = YES
SEARCH_INCLUDES        = YES
INCLUDE_PATH           =
INCLUDE_FILE_PATTERNS  =
PREDEFINED             =
EXPAND_AS_DEFINED      =

# For PHP
OPTIMIZE_OUTPUT_FOR_C  = NO
OPTIMIZE_OUTPUT_JAVA   = NO
OPTIMIZE_FOR_FORTRAN   = NO
OPTIMIZE_OUTPUT_VHDL   = NO
EXTRACT_ALL            = YES
EXTRACT_PRIVATE        = YES
EXTRACT_STATIC         = YES
EXTRACT_LOCAL_CLASSES  = YES
EXTRACT_LOCAL_METHODS  = YES
EXTRACT_ANON_NSPACES   = YES
HIDE_UNDOC_MEMBERS     = NO
HIDE_UNDOC_CLASSES     = NO
HIDE_FRIEND_COMPOUNDS  = NO
HIDE_IN_BODY_DOCS      = NO

# Docs
INTERNAL_DOCS          = YES
CASE_SENSE_NAMES       = NO
HIDE_SCOPE_NAMES       = NO
SHOW_INCLUDE_FILES     = YES
FORCE_LOCAL_INCLUDES   = NO
INLINE_INFO            = YES
SORT_MEMBER_DOCS       = YES
SORT_BRIEF_DOCS        = NO
SORT_MEMBERS_CTORS_1ST = YES
SORT_GROUP_NAMES       = NO
SORT_BY_SCOPE_NAME     = NO
GENERATE_TODOLIST      = YES
GENERATE_TESTLIST      = YES
GENERATE_BUGLIST       = YES
GENERATE_DEPRECATEDLIST= YES

# Lang
OUTPUT_LANGUAGE        = English

# HTML output
GENERATE_HTML          = YES
HTML_OUTPUT            = html
HTML_FILE_EXTENSION    = .html
HTML_COLORSTYLE_HUE    = 220
HTML_DYNAMIC_SECTIONS  = NO

# LaTeX for PDF
GENERATE_LATEX         = YES
LATEX_OUTPUT           = latex
LATEX_CMD_NAME         = pdflatex
USE_PDFLATEX           = YES
PDF_HYPERLINKS         = YES
COMPACT_LATEX          = NO
LATEX_HEADER           =
LATEX_FOOTER           =

# PDF config
LATEX_BATCHMODE        = NO
LATEX_HIDE_INDICES     = NO

# Extra
ALPHABETICAL_INDEX     = YES
GENERATE_TREEVIEW      = ALL
DISABLE_INDEX          = NO
ENUM_VALUES_PER_LINE   = 4
SEARCHENGINE           = YES
SERVER_BASED_SEARCH    = NO
HAVE_DOT               = YES
UML_LOOK               = YES