Skip to content

Commit b7cd8a8

Browse files
Gleb-ShallGleb-Shall
committed
Move Doxyfile to root directory and update paths
1 parent 55c7b65 commit b7cd8a8

2 files changed

Lines changed: 360 additions & 6 deletions

File tree

‎.github/workflows/deploy-docs.yml‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -20,18 +20,16 @@ jobs:
2020
- name: Generate Documentation
2121
run: |
2222
echo "Current directory: $(pwd)"
23+
echo "Checking if Doxyfile exists in root:"
24+
ls -la Doxyfile
2325
echo "Contents of lab2 directory:"
2426
ls -la lab2/
25-
echo "Checking if Doxyfile exists:"
26-
ls -la lab2/Doxyfile
27-
cd lab2
28-
echo "After cd lab2, current directory: $(pwd)"
29-
doxygen ./Doxyfile
27+
doxygen Doxyfile
3028
3129
- name: Deploy to GitHub Pages
3230
uses: peaceiris/actions-gh-pages@v3
3331
if: github.ref == 'refs/heads/main' || github.ref == 'refs/heads/develope'
3432
with:
3533
github_token: ${{ secrets.GITHUB_TOKEN }}
36-
publish_dir: ./lab2/docs/html
34+
publish_dir: ./docs/html
3735
destination_dir: docs

‎Doxyfile‎

Lines changed: 356 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,356 @@
1+
# Doxyfile configuration for RPG Adventure Game
2+
# Generated by Gleb Shikunov
3+
4+
#---------------------------------------------------------------------------
5+
# Project related configuration options
6+
#---------------------------------------------------------------------------
7+
DOXYFILE_ENCODING = UTF-8
8+
PROJECT_NAME = "RPG Adventure Game"
9+
PROJECT_NUMBER = 1.0
10+
PROJECT_BRIEF = "A console-based RPG game with combat, inventory, and quest systems"
11+
PROJECT_LOGO =
12+
OUTPUT_DIRECTORY = docs
13+
CREATE_SUBDIRS = NO
14+
ALLOW_UNICODE_NAMES = NO
15+
OUTPUT_LANGUAGE = English
16+
BRIEF_MEMBER_DESC = YES
17+
REPEAT_BRIEF = YES
18+
ABBREVIATE_BRIEF = "The $name class" \
19+
"The $name widget" \
20+
"The $name file" \
21+
is \
22+
provides \
23+
specifies \
24+
contains \
25+
represents \
26+
a \
27+
an \
28+
the
29+
ALWAYS_DETAILED_SEC = NO
30+
INLINE_INHERITED_MEMB = NO
31+
FULL_PATH_NAMES = YES
32+
STRIP_FROM_PATH =
33+
STRIP_FROM_INC_PATH =
34+
SHORT_NAMES = NO
35+
JAVADOC_AUTOBRIEF = YES
36+
QT_AUTOBRIEF = NO
37+
MULTILINE_CPP_IS_BRIEF = NO
38+
INHERIT_DOCS = YES
39+
SEPARATE_MEMBER_PAGES = NO
40+
TAB_SIZE = 4
41+
ALIASES =
42+
TCL_SUBST =
43+
OPTIMIZE_OUTPUT_FOR_C = NO
44+
OPTIMIZE_OUTPUT_JAVA = NO
45+
OPTIMIZE_FOR_FORTRAN = NO
46+
OPTIMIZE_OUTPUT_VHDL = NO
47+
EXTENSION_MAPPING =
48+
MARKDOWN_SUPPORT = YES
49+
TOC_INCLUDE_HEADINGS = 0
50+
AUTOLINK_SUPPORT = YES
51+
BUILTIN_STL_SUPPORT = NO
52+
CPP_CLI_SUPPORT = NO
53+
SIP_SUPPORT = NO
54+
IDL_PROPERTY_SUPPORT = YES
55+
DISTRIBUTE_GROUP_DOC = NO
56+
GROUP_GRAPHS = YES
57+
DISABLE_INDEX = NO
58+
GENERATE_TREEVIEW = YES
59+
ENUM_VALUES_PER_LINE = 4
60+
TREEVIEW_WIDTH = 250
61+
EXT_LINKS_IN_WINDOW = NO
62+
FORMULA_FONTSIZE = 10
63+
FORMULA_TRANSPARENT = YES
64+
USE_MATHJAX = NO
65+
SEARCHENGINE = YES
66+
SERVER_BASED_SEARCH = NO
67+
EXTERNAL_SEARCH = NO
68+
SEARCHENGINE_URL =
69+
SEARCHDATA_FILE = searchdata.xml
70+
EXTERNAL_SEARCH_ID =
71+
EXTRA_SEARCH_MAPPINGS =
72+
#---------------------------------------------------------------------------
73+
# Build related configuration options
74+
#---------------------------------------------------------------------------
75+
EXTRACT_ALL = YES
76+
EXTRACT_PRIVATE = YES
77+
EXTRACT_PACKAGE = NO
78+
EXTRACT_STATIC = YES
79+
EXTRACT_LOCAL_CLASSES = YES
80+
EXTRACT_LOCAL_METHODS = NO
81+
EXTRACT_ANON_NSPACES = NO
82+
HIDE_UNDOC_MEMBERS = NO
83+
HIDE_UNDOC_CLASSES = NO
84+
HIDE_FRIEND_COMPOUNDS = NO
85+
HIDE_IN_BODY_DOCS = NO
86+
INTERNAL_DOCS = NO
87+
CASE_SENSE_NAMES = YES
88+
HIDE_SCOPE_NAMES = NO
89+
HIDE_COMPOUND_REFERENCE= NO
90+
SHOW_HEADERFILE = YES
91+
SHOW_INCLUDE_FILES = YES
92+
SHOW_GROUPED_MEMB_INC = NO
93+
FORCE_LOCAL_INCLUDES = NO
94+
INLINE_INFO = YES
95+
SORT_MEMBER_DOCS = YES
96+
SORT_BRIEF_DOCS = NO
97+
SORT_MEMBERS_CTORS_1ST = NO
98+
SORT_GROUP_NAMES = NO
99+
SORT_BY_SCOPE_NAME = NO
100+
STRICT_PROTO_MATCHING = NO
101+
GENERATE_TODOLIST = YES
102+
GENERATE_TESTLIST = YES
103+
GENERATE_BUGLIST = YES
104+
GENERATE_DEPRECATEDLIST= YES
105+
ENABLED_SECTIONS =
106+
MAX_INITIALIZER_LINES = 30
107+
SHOW_USED_FILES = YES
108+
SHOW_FILES = YES
109+
SHOW_NAMESPACES = YES
110+
FILE_VERSION_FILTER =
111+
LAYOUT_FILE =
112+
CITE_BIB_FILES =
113+
#---------------------------------------------------------------------------
114+
# Input related configuration options
115+
#---------------------------------------------------------------------------
116+
INPUT = lab2/main.md lab2/game/include/ lab2/game/src/
117+
INPUT_ENCODING = UTF-8
118+
FILE_PATTERNS = *.c \
119+
*.cc \
120+
*.cxx \
121+
*.cpp \
122+
*.c++ \
123+
*.java \
124+
*.ii \
125+
*.ixx \
126+
*.ipp \
127+
*.i++ \
128+
*.inl \
129+
*.idl \
130+
*.ddl \
131+
*.odl \
132+
*.h \
133+
*.hh \
134+
*.hxx \
135+
*.hpp \
136+
*.h++ \
137+
*.cs \
138+
*.d \
139+
*.php \
140+
*.php4 \
141+
*.php5 \
142+
*.phtml \
143+
*.inc \
144+
*.m \
145+
*.markdown \
146+
*.md \
147+
*.mm \
148+
*.dox \
149+
*.py \
150+
*.pyw \
151+
*.f90 \
152+
*.f95 \
153+
*.f03 \
154+
*.f08 \
155+
*.f \
156+
*.for \
157+
*.tcl \
158+
*.vhd \
159+
*.vhdl
160+
RECURSIVE = YES
161+
EXCLUDE =
162+
EXCLUDE_SYMLINKS = NO
163+
EXCLUDE_PATTERNS =
164+
EXCLUDE_SYMBOLS =
165+
EXAMPLE_PATH =
166+
EXAMPLE_PATTERNS = *
167+
EXAMPLE_RECURSIVE = NO
168+
IMAGE_PATH =
169+
INPUT_FILTER =
170+
FILTER_PATTERNS =
171+
FILTER_SOURCE_FILES = NO
172+
FILTER_SOURCE_PATTERNS =
173+
USE_MDFILE_AS_MAINPAGE = main.md
174+
#---------------------------------------------------------------------------
175+
# Source browsing related configuration options
176+
#---------------------------------------------------------------------------
177+
SOURCE_BROWSER = YES
178+
INLINE_SOURCES = NO
179+
STRIP_CODE_COMMENTS = YES
180+
REFERENCED_BY_RELATION = NO
181+
REFERENCES_RELATION = NO
182+
REFERENCES_LINK_SOURCE = YES
183+
SOURCE_TOOLTIPS = YES
184+
USE_HTAGS = NO
185+
VERBATIM_HEADERS = YES
186+
CLANG_ASSISTED_PARSING = NO
187+
CLANG_ADD_INC_PATHS = YES
188+
CLANG_OPTIONS =
189+
CLANG_DATABASE_PATH =
190+
#---------------------------------------------------------------------------
191+
# Alphabetical class index
192+
#---------------------------------------------------------------------------
193+
ALPHABETICAL_INDEX = YES
194+
COLS_IN_ALPHA_INDEX = 5
195+
IGNORE_PREFIX =
196+
#---------------------------------------------------------------------------
197+
# HTML related configuration options
198+
#---------------------------------------------------------------------------
199+
GENERATE_HTML = YES
200+
HTML_OUTPUT = html
201+
HTML_FILE_EXTENSION = .html
202+
HTML_HEADER =
203+
HTML_FOOTER =
204+
HTML_STYLESHEET =
205+
HTML_EXTRA_STYLESHEET =
206+
HTML_EXTRA_FILES =
207+
HTML_COLORSTYLE_HUE = 220
208+
HTML_COLORSTYLE_SAT = 100
209+
HTML_COLORSTYLE_GAMMA = 80
210+
HTML_TIMESTAMP = NO
211+
HTML_DYNAMIC_MENUS = YES
212+
HTML_DYNAMIC_SECTIONS = NO
213+
HTML_INDEX_NUM_ENTRIES = 100
214+
GENERATE_DOCSET = NO
215+
DOCSET_FEEDNAME = "Doxygen generated docs"
216+
DOCSET_BUNDLE_ID = org.doxygen.Project
217+
DOCSET_PUBLISHER_ID = org.doxygen.Publisher
218+
DOCSET_PUBLISHER_NAME = Publisher
219+
GENERATE_HTMLHELP = NO
220+
CHM_FILE =
221+
HHC_LOCATION =
222+
GENERATE_CHI = NO
223+
CHM_INDEX_ENCODING =
224+
BINARY_TOC = NO
225+
TOC_EXPAND = NO
226+
GENERATE_QHP = NO
227+
QCH_FILE =
228+
QHP_NAMESPACE = org.doxygen.Project
229+
QHP_VIRTUAL_FOLDER = doc
230+
QHP_CUST_FILTER_NAME =
231+
QHP_CUST_FILTER_ATTRS =
232+
QHP_SECT_FILTER_ATTRS =
233+
QHG_LOCATION =
234+
GENERATE_ECLIPSEHELP = NO
235+
ECLIPSE_DOC_ID = org.doxygen.Project
236+
DISABLE_INDEX = NO
237+
GENERATE_TREEVIEW = YES
238+
ENUM_VALUES_PER_LINE = 4
239+
TREEVIEW_WIDTH = 250
240+
EXT_LINKS_IN_WINDOW = NO
241+
FORMULA_FONTSIZE = 10
242+
FORMULA_TRANSPARENT = YES
243+
USE_MATHJAX = NO
244+
SEARCHENGINE = YES
245+
SERVER_BASED_SEARCH = NO
246+
EXTERNAL_SEARCH = NO
247+
SEARCHENGINE_URL =
248+
SEARCHDATA_FILE = searchdata.xml
249+
EXTERNAL_SEARCH_ID =
250+
EXTRA_SEARCH_MAPPINGS =
251+
#---------------------------------------------------------------------------
252+
# LaTeX related configuration options
253+
#---------------------------------------------------------------------------
254+
GENERATE_LATEX = NO
255+
LATEX_OUTPUT = latex
256+
LATEX_CMD_NAME = latex
257+
MAKEINDEX_CMD_NAME = makeindex
258+
COMPACT_LATEX = NO
259+
PAPER_TYPE = a4
260+
EXTRA_PACKAGES =
261+
LATEX_HEADER =
262+
LATEX_FOOTER =
263+
LATEX_EXTRA_STYLESHEET =
264+
LATEX_EXTRA_FILES =
265+
PDF_HYPERLINKS = YES
266+
USE_PDFLATEX = YES
267+
LATEX_BATCHMODE = NO
268+
LATEX_HIDE_INDICES = NO
269+
LATEX_SOURCE_CODE = NO
270+
LATEX_BIB_STYLE = plain
271+
LATEX_TIMESTAMP = NO
272+
#---------------------------------------------------------------------------
273+
# RTF related configuration options
274+
#---------------------------------------------------------------------------
275+
GENERATE_RTF = NO
276+
RTF_OUTPUT = rtf
277+
COMPACT_RTF = NO
278+
RTF_HYPERLINKS = NO
279+
RTF_STYLESHEET_FILE =
280+
RTF_EXTENSIONS_FILE =
281+
RTF_SOURCE_CODE = NO
282+
RTF_EXTRA_FILES =
283+
#---------------------------------------------------------------------------
284+
# Man page related configuration options
285+
#---------------------------------------------------------------------------
286+
GENERATE_MAN = NO
287+
MAN_OUTPUT = man
288+
MAN_EXTENSION = .3
289+
MAN_SUBDIR =
290+
MAN_LINKS = NO
291+
#---------------------------------------------------------------------------
292+
# XML related configuration options
293+
#---------------------------------------------------------------------------
294+
GENERATE_XML = NO
295+
XML_OUTPUT = xml
296+
XML_PROGRAMLISTING = YES
297+
#---------------------------------------------------------------------------
298+
# Preprocessor related configuration options
299+
#---------------------------------------------------------------------------
300+
ENABLE_PREPROCESSING = YES
301+
MACRO_EXPANSION = NO
302+
EXPAND_ONLY_PREDEF = NO
303+
SEARCH_INCLUDES = YES
304+
INCLUDE_PATH =
305+
INCLUDE_FILE_PATTERNS =
306+
PREDEFINED =
307+
EXPAND_AS_DEFINED =
308+
SKIP_FUNCTION_MACROS = YES
309+
#---------------------------------------------------------------------------
310+
# External references configuration options
311+
#---------------------------------------------------------------------------
312+
TAGFILES =
313+
GENERATE_TAGFILE =
314+
ALLEXTERNALS = NO
315+
EXTERNAL_GROUPS = YES
316+
EXTERNAL_PAGES = YES
317+
PERL_PATH = /usr/bin/perl
318+
#---------------------------------------------------------------------------
319+
# Dot tool related configuration options
320+
#---------------------------------------------------------------------------
321+
CLASS_DIAGRAMS = YES
322+
MSCGEN_PATH =
323+
DIA_PATH =
324+
HIDE_UNDOC_RELATIONS = YES
325+
HAVE_DOT = YES
326+
DOT_NUM_THREADS = 0
327+
DOT_FONTNAME = Helvetica
328+
DOT_FONTSIZE = 10
329+
DOT_FONTPATH =
330+
CLASS_GRAPH = YES
331+
COLLABORATION_GRAPH = YES
332+
GROUP_GRAPHS = YES
333+
UML_LOOK = NO
334+
UML_LIMIT_NUM_FIELDS = 10
335+
TEMPLATE_RELATIONS = NO
336+
INCLUDE_GRAPH = YES
337+
INCLUDED_BY_GRAPH = YES
338+
CALL_GRAPH = NO
339+
CALLER_GRAPH = NO
340+
GRAPHICAL_HIERARCHY = YES
341+
DIRECTORY_GRAPH = YES
342+
DOT_IMAGE_FORMAT = png
343+
INTERACTIVE_SVG = NO
344+
DOT_PATH =
345+
DOTFILE_DIRS =
346+
MSCFILE_DIRS =
347+
DIAFILE_DIRS =
348+
PLANTUML_JAR_PATH =
349+
PLANTUML_CFG_FILE =
350+
PLANTUML_INCLUDE_PATH =
351+
DOT_GRAPH_MAX_NODES = 50
352+
MAX_DOT_GRAPH_DEPTH = 0
353+
DOT_TRANSPARENT = NO
354+
DOT_MULTI_TARGETS = NO
355+
GENERATE_LEGEND = YES
356+
DOT_CLEANUP = YES

0 commit comments

Comments
 (0)