Skip to content

Commit 0384343

Browse files
adding doxygen files
1 parent e13d9f6 commit 0384343

File tree

2 files changed

+301
-0
lines changed

2 files changed

+301
-0
lines changed

doc/code/Doxyfile

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

doc/code/index.doxygen

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,16 @@
1+
/** @mainpage AvTranscoder
2+
*
3+
* See the website for a full presentation and the general documentation.
4+
*
5+
* https://github.com/MarcAntoine-Arnaud/avTranscoder
6+
*
7+
* - using C++ API on FFMpeg / LibAV
8+
* - participate to the project developpement
9+
*
10+
* Authors
11+
* - Marc-Antoine Arnaud
12+
* - Valentin Noël
13+
* - Clément Champetier
14+
*
15+
*/
16+

0 commit comments

Comments
 (0)