Skip to content

Commit ce7e241

Browse files
author
Stefan Reinauer
committed
add toke doxygen documentation target
git-svn-id: svn://coreboot.org/openbios/fcode-utils@78 f158a5a8-5612-0410-a976-696ce0be7e32
1 parent 26efe18 commit ce7e241

2 files changed

Lines changed: 275 additions & 0 deletions

File tree

‎toke/Makefile‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,9 @@ distclean: clean
5151
.dependencies: *.c
5252
@$(CC) $(CFLAGS) $(INCLUDES) -MM *.c > .dependencies
5353

54+
documentation:: *.c *.h toke.doxygen
55+
@doxygen toke.doxygen
56+
5457
.PHONY: all clean distclean
5558

5659
-include .dependencies

‎toke/toke.doxygen‎

Lines changed: 272 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,272 @@
1+
# Doxyfile 1.4.4
2+
3+
#---------------------------------------------------------------------------
4+
# Project related configuration options
5+
#---------------------------------------------------------------------------
6+
PROJECT_NAME = Toke
7+
PROJECT_NUMBER =
8+
OUTPUT_DIRECTORY = .
9+
CREATE_SUBDIRS = YES
10+
OUTPUT_LANGUAGE = English
11+
USE_WINDOWS_ENCODING = NO
12+
BRIEF_MEMBER_DESC = YES
13+
REPEAT_BRIEF = YES
14+
ABBREVIATE_BRIEF = "The $name class" \
15+
"The $name widget" \
16+
"The $name file" \
17+
is \
18+
provides \
19+
specifies \
20+
contains \
21+
represents \
22+
a \
23+
an \
24+
the
25+
ALWAYS_DETAILED_SEC = NO
26+
INLINE_INHERITED_MEMB = NO
27+
FULL_PATH_NAMES = NO
28+
STRIP_FROM_PATH =
29+
STRIP_FROM_INC_PATH =
30+
SHORT_NAMES = NO
31+
JAVADOC_AUTOBRIEF = YES
32+
MULTILINE_CPP_IS_BRIEF = NO
33+
DETAILS_AT_TOP = NO
34+
INHERIT_DOCS = YES
35+
DISTRIBUTE_GROUP_DOC = NO
36+
SEPARATE_MEMBER_PAGES = NO
37+
TAB_SIZE = 8
38+
ALIASES =
39+
OPTIMIZE_OUTPUT_FOR_C = YES
40+
OPTIMIZE_OUTPUT_JAVA = NO
41+
SUBGROUPING = YES
42+
#---------------------------------------------------------------------------
43+
# Build related configuration options
44+
#---------------------------------------------------------------------------
45+
EXTRACT_ALL = YES
46+
EXTRACT_PRIVATE = YES
47+
EXTRACT_STATIC = YES
48+
EXTRACT_LOCAL_CLASSES = YES
49+
EXTRACT_LOCAL_METHODS = NO
50+
HIDE_UNDOC_MEMBERS = NO
51+
HIDE_UNDOC_CLASSES = NO
52+
HIDE_FRIEND_COMPOUNDS = NO
53+
HIDE_IN_BODY_DOCS = NO
54+
INTERNAL_DOCS = NO
55+
CASE_SENSE_NAMES = YES
56+
HIDE_SCOPE_NAMES = NO
57+
SHOW_INCLUDE_FILES = YES
58+
INLINE_INFO = YES
59+
SORT_MEMBER_DOCS = YES
60+
SORT_BRIEF_DOCS = NO
61+
SORT_BY_SCOPE_NAME = NO
62+
GENERATE_TODOLIST = YES
63+
GENERATE_TESTLIST = YES
64+
GENERATE_BUGLIST = YES
65+
GENERATE_DEPRECATEDLIST= YES
66+
ENABLED_SECTIONS =
67+
MAX_INITIALIZER_LINES = 30
68+
SHOW_USED_FILES = YES
69+
SHOW_DIRECTORIES = YES
70+
FILE_VERSION_FILTER =
71+
#---------------------------------------------------------------------------
72+
# configuration options related to warning and progress messages
73+
#---------------------------------------------------------------------------
74+
QUIET = NO
75+
WARNINGS = YES
76+
WARN_IF_UNDOCUMENTED = YES
77+
WARN_IF_DOC_ERROR = YES
78+
WARN_NO_PARAMDOC = NO
79+
WARN_FORMAT = "$file:$line: $text"
80+
WARN_LOGFILE =
81+
#---------------------------------------------------------------------------
82+
# configuration options related to the input files
83+
#---------------------------------------------------------------------------
84+
INPUT =
85+
FILE_PATTERNS = *.c \
86+
*.cc \
87+
*.cxx \
88+
*.cpp \
89+
*.c++ \
90+
*.d \
91+
*.java \
92+
*.ii \
93+
*.ixx \
94+
*.ipp \
95+
*.i++ \
96+
*.inl \
97+
*.h \
98+
*.hh \
99+
*.hxx \
100+
*.hpp \
101+
*.h++ \
102+
*.idl \
103+
*.odl \
104+
*.cs \
105+
*.php \
106+
*.php3 \
107+
*.inc \
108+
*.m \
109+
*.mm \
110+
*.dox \
111+
*.C \
112+
*.CC \
113+
*.C++ \
114+
*.II \
115+
*.I++ \
116+
*.H \
117+
*.HH \
118+
*.H++ \
119+
*.CS \
120+
*.PHP \
121+
*.PHP3 \
122+
*.M \
123+
*.MM
124+
RECURSIVE = YES
125+
EXCLUDE =
126+
EXCLUDE_SYMLINKS = NO
127+
EXCLUDE_PATTERNS =
128+
EXAMPLE_PATH =
129+
EXAMPLE_PATTERNS =
130+
EXAMPLE_RECURSIVE = NO
131+
IMAGE_PATH =
132+
INPUT_FILTER =
133+
FILTER_PATTERNS =
134+
FILTER_SOURCE_FILES = NO
135+
#---------------------------------------------------------------------------
136+
# configuration options related to source browsing
137+
#---------------------------------------------------------------------------
138+
SOURCE_BROWSER = YES
139+
INLINE_SOURCES = NO
140+
STRIP_CODE_COMMENTS = YES
141+
REFERENCED_BY_RELATION = YES
142+
REFERENCES_RELATION = YES
143+
USE_HTAGS = NO
144+
VERBATIM_HEADERS = YES
145+
#---------------------------------------------------------------------------
146+
# configuration options related to the alphabetical class index
147+
#---------------------------------------------------------------------------
148+
ALPHABETICAL_INDEX = NO
149+
COLS_IN_ALPHA_INDEX = 5
150+
IGNORE_PREFIX =
151+
#---------------------------------------------------------------------------
152+
# configuration options related to the HTML output
153+
#---------------------------------------------------------------------------
154+
GENERATE_HTML = YES
155+
HTML_OUTPUT = toke-html
156+
HTML_FILE_EXTENSION = .html
157+
HTML_HEADER =
158+
HTML_FOOTER =
159+
HTML_STYLESHEET =
160+
HTML_ALIGN_MEMBERS = YES
161+
GENERATE_HTMLHELP = NO
162+
CHM_FILE =
163+
HHC_LOCATION =
164+
GENERATE_CHI = NO
165+
BINARY_TOC = NO
166+
TOC_EXPAND = NO
167+
DISABLE_INDEX = NO
168+
ENUM_VALUES_PER_LINE = 4
169+
GENERATE_TREEVIEW = YES
170+
TREEVIEW_WIDTH = 250
171+
#---------------------------------------------------------------------------
172+
# configuration options related to the LaTeX output
173+
#---------------------------------------------------------------------------
174+
GENERATE_LATEX = NO
175+
LATEX_OUTPUT = latex
176+
LATEX_CMD_NAME = latex
177+
MAKEINDEX_CMD_NAME = makeindex
178+
COMPACT_LATEX = NO
179+
PAPER_TYPE = a4wide
180+
EXTRA_PACKAGES =
181+
LATEX_HEADER =
182+
PDF_HYPERLINKS = YES
183+
USE_PDFLATEX = YES
184+
LATEX_BATCHMODE = NO
185+
LATEX_HIDE_INDICES = NO
186+
#---------------------------------------------------------------------------
187+
# configuration options related to the RTF output
188+
#---------------------------------------------------------------------------
189+
GENERATE_RTF = NO
190+
RTF_OUTPUT = rtf
191+
COMPACT_RTF = NO
192+
RTF_HYPERLINKS = NO
193+
RTF_STYLESHEET_FILE =
194+
RTF_EXTENSIONS_FILE =
195+
#---------------------------------------------------------------------------
196+
# configuration options related to the man page output
197+
#---------------------------------------------------------------------------
198+
GENERATE_MAN = NO
199+
MAN_OUTPUT = man
200+
MAN_EXTENSION = .3
201+
MAN_LINKS = NO
202+
#---------------------------------------------------------------------------
203+
# configuration options related to the XML output
204+
#---------------------------------------------------------------------------
205+
GENERATE_XML = NO
206+
XML_OUTPUT = xml
207+
XML_SCHEMA =
208+
XML_DTD =
209+
XML_PROGRAMLISTING = YES
210+
#---------------------------------------------------------------------------
211+
# configuration options for the AutoGen Definitions output
212+
#---------------------------------------------------------------------------
213+
GENERATE_AUTOGEN_DEF = NO
214+
#---------------------------------------------------------------------------
215+
# configuration options related to the Perl module output
216+
#---------------------------------------------------------------------------
217+
GENERATE_PERLMOD = NO
218+
PERLMOD_LATEX = NO
219+
PERLMOD_PRETTY = YES
220+
PERLMOD_MAKEVAR_PREFIX =
221+
#---------------------------------------------------------------------------
222+
# Configuration options related to the preprocessor
223+
#---------------------------------------------------------------------------
224+
ENABLE_PREPROCESSING = YES
225+
MACRO_EXPANSION = NO
226+
EXPAND_ONLY_PREDEF = NO
227+
SEARCH_INCLUDES = YES
228+
INCLUDE_PATH =
229+
INCLUDE_FILE_PATTERNS =
230+
PREDEFINED =
231+
EXPAND_AS_DEFINED =
232+
SKIP_FUNCTION_MACROS = YES
233+
#---------------------------------------------------------------------------
234+
# Configuration::additions related to external references
235+
#---------------------------------------------------------------------------
236+
TAGFILES =
237+
GENERATE_TAGFILE =
238+
ALLEXTERNALS = NO
239+
EXTERNAL_GROUPS = YES
240+
PERL_PATH = /usr/bin/perl
241+
#---------------------------------------------------------------------------
242+
# Configuration options related to the dot tool
243+
#---------------------------------------------------------------------------
244+
CLASS_DIAGRAMS = YES
245+
HIDE_UNDOC_RELATIONS = YES
246+
HAVE_DOT = YES
247+
CLASS_GRAPH = YES
248+
COLLABORATION_GRAPH = YES
249+
GROUP_GRAPHS = YES
250+
UML_LOOK = YES
251+
TEMPLATE_RELATIONS = NO
252+
INCLUDE_GRAPH = YES
253+
INCLUDED_BY_GRAPH = YES
254+
CALL_GRAPH = YES
255+
CALLER_GRAPH = YES
256+
GRAPHICAL_HIERARCHY = YES
257+
DIRECTORY_GRAPH = YES
258+
DOT_IMAGE_FORMAT = png
259+
DOT_PATH =
260+
DOTFILE_DIRS =
261+
MAX_DOT_GRAPH_WIDTH = 1024
262+
MAX_DOT_GRAPH_HEIGHT = 1024
263+
MAX_DOT_GRAPH_DEPTH = 1000
264+
DOT_TRANSPARENT = NO
265+
DOT_MULTI_TARGETS = NO
266+
GENERATE_LEGEND = YES
267+
DOT_CLEANUP = YES
268+
#---------------------------------------------------------------------------
269+
# Configuration::additions related to the search engine
270+
#---------------------------------------------------------------------------
271+
SEARCHENGINE = NO
272+
INPUT= clflags.c clflags.h conditl.c conditl.h devnode.c devnode.h dictionary.c dictionary.h emit.c emit.h errhandler.c errhandler.h flowcontrol.c flowcontrol.h macros.c macros.h nextfcode.c nextfcode.h parselocals.c parselocals.h scanner.c scanner.h stack.c stack.h stream.c stream.h strsubvocab.c strsubvocab.h ticvocab.c ticvocab.h toke.c toke.h tokzesc.c tokzesc.h tracesyms.c tracesyms.h usersymbols.c usersymbols.h vocabfuncts.h

0 commit comments

Comments
 (0)