Skip to content

Commit 773ee17

Browse files
committed
Customize doxyfile and ignore doxygen build output
1 parent 8e7f85e commit 773ee17

File tree

2 files changed

+31
-60
lines changed

2 files changed

+31
-60
lines changed

.gitignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,3 +18,4 @@ JLink.log
1818
*~
1919
.DS_Store
2020
.custom.vim
21+
docs/dox

docs/doxyfile

Lines changed: 30 additions & 60 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ DOXYFILE_ENCODING = UTF-8
3232
# title of most generated pages and in a few other places.
3333
# The default value is: My Project.
3434

35-
PROJECT_NAME = "My Project"
35+
PROJECT_NAME = uVisor
3636

3737
# The PROJECT_NUMBER tag can be used to enter a project or revision number. This
3838
# could be handy for archiving the generated documentation or if some version
@@ -58,7 +58,7 @@ PROJECT_LOGO =
5858
# entered, it will be relative to the location where doxygen was started. If
5959
# left blank the current directory will be used.
6060

61-
OUTPUT_DIRECTORY =
61+
OUTPUT_DIRECTORY = dox
6262

6363
# If the CREATE_SUBDIRS tag is set to YES then doxygen will create 4096 sub-
6464
# directories (in 2 levels) under the output directory of each output format and
@@ -107,7 +107,7 @@ BRIEF_MEMBER_DESC = YES
107107
# brief descriptions will be completely suppressed.
108108
# The default value is: YES.
109109

110-
REPEAT_BRIEF = YES
110+
REPEAT_BRIEF = NO
111111

112112
# This tag implements a quasi-intelligent brief description abbreviator that is
113113
# used to form the text in various listings. Each string in this list, if found
@@ -252,7 +252,7 @@ TCL_SUBST =
252252
# members will be omitted, etc.
253253
# The default value is: NO.
254254

255-
OPTIMIZE_OUTPUT_FOR_C = NO
255+
OPTIMIZE_OUTPUT_FOR_C = YES
256256

257257
# Set the OPTIMIZE_OUTPUT_JAVA tag to YES if your project consists of Java or
258258
# Python sources only. Doxygen will then generate output that is more tailored
@@ -367,7 +367,7 @@ DISTRIBUTE_GROUP_DOC = NO
367367
# is disabled and one has to add nested compounds explicitly via \ingroup.
368368
# The default value is: NO.
369369

370-
GROUP_NESTED_COMPOUNDS = NO
370+
GROUP_NESTED_COMPOUNDS = YES
371371

372372
# Set the SUBGROUPING tag to YES to allow class member groups of the same type
373373
# (for instance a group of public functions) to be put as a subgroup of that
@@ -397,7 +397,7 @@ INLINE_GROUPED_CLASSES = NO
397397
# Man pages) or section (for LaTeX and RTF).
398398
# The default value is: NO.
399399

400-
INLINE_SIMPLE_STRUCTS = NO
400+
INLINE_SIMPLE_STRUCTS = YES
401401

402402
# When TYPEDEF_HIDES_STRUCT tag is enabled, a typedef of a struct, union, or
403403
# enum is documented as struct, union, or enum with the name of the typedef. So
@@ -563,7 +563,7 @@ FORCE_LOCAL_INCLUDES = NO
563563
# documentation for inline members.
564564
# The default value is: YES.
565565

566-
INLINE_INFO = YES
566+
INLINE_INFO = NO
567567

568568
# If the SORT_MEMBER_DOCS tag is set to YES then doxygen will sort the
569569
# (detailed) documentation of file and class members alphabetically by member
@@ -659,7 +659,7 @@ ENABLED_SECTIONS =
659659
# documentation regardless of this setting.
660660
# Minimum value: 0, maximum value: 10000, default value: 30.
661661

662-
MAX_INITIALIZER_LINES = 30
662+
MAX_INITIALIZER_LINES = 0
663663

664664
# Set the SHOW_USED_FILES tag to NO to disable the list of files generated at
665665
# the bottom of the documentation of classes and structs. If set to YES, the
@@ -790,7 +790,7 @@ WARN_LOGFILE =
790790
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
791791
# Note: If this tag is empty the current directory is searched.
792792

793-
INPUT =
793+
INPUT = ../api
794794

795795
# This tag can be used to specify the character encoding of the source files
796796
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -815,56 +815,14 @@ INPUT_ENCODING = UTF-8
815815
# *.m, *.markdown, *.md, *.mm, *.dox, *.py, *.pyw, *.f90, *.f95, *.f03, *.f08,
816816
# *.f, *.for, *.tcl, *.vhd, *.vhdl, *.ucf and *.qsf.
817817

818-
FILE_PATTERNS = *.c \
819-
*.cc \
820-
*.cxx \
821-
*.cpp \
822-
*.c++ \
823-
*.java \
824-
*.ii \
825-
*.ixx \
826-
*.ipp \
827-
*.i++ \
828-
*.inl \
829-
*.idl \
830-
*.ddl \
831-
*.odl \
832-
*.h \
833-
*.hh \
834-
*.hxx \
835-
*.hpp \
836-
*.h++ \
837-
*.cs \
838-
*.d \
839-
*.php \
840-
*.php4 \
841-
*.php5 \
842-
*.phtml \
843-
*.inc \
844-
*.m \
845-
*.markdown \
846-
*.md \
847-
*.mm \
848-
*.dox \
849-
*.py \
850-
*.pyw \
851-
*.f90 \
852-
*.f95 \
853-
*.f03 \
854-
*.f08 \
855-
*.f \
856-
*.for \
857-
*.tcl \
858-
*.vhd \
859-
*.vhdl \
860-
*.ucf \
861-
*.qsf
818+
FILE_PATTERNS = *.h \
819+
*.dox
862820

863821
# The RECURSIVE tag can be used to specify whether or not subdirectories should
864822
# be searched for input files as well.
865823
# The default value is: NO.
866824

867-
RECURSIVE = NO
825+
RECURSIVE = YES
868826

869827
# The EXCLUDE tag can be used to specify files and/or directories that should be
870828
# excluded from the INPUT source files. This way you can easily exclude a
@@ -873,7 +831,7 @@ RECURSIVE = NO
873831
# Note that relative paths are relative to the directory from which doxygen is
874832
# run.
875833

876-
EXCLUDE =
834+
EXCLUDE = .git*
877835

878836
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
879837
# directories that are symbolic links (a Unix file system feature) are excluded
@@ -926,7 +884,7 @@ EXAMPLE_RECURSIVE = NO
926884
# that contain images that are to be included in the documentation (see the
927885
# \image command).
928886

929-
IMAGE_PATH =
887+
IMAGE_PATH = ../docs/img
930888

931889
# The INPUT_FILTER tag can be used to specify a program that doxygen should
932890
# invoke to filter for each input file. Doxygen will invoke the filter program
@@ -1647,7 +1605,7 @@ EXTRA_SEARCH_MAPPINGS =
16471605
# If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
16481606
# The default value is: YES.
16491607

1650-
GENERATE_LATEX = YES
1608+
GENERATE_LATEX = NO
16511609

16521610
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
16531611
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of
@@ -2040,15 +1998,15 @@ ENABLE_PREPROCESSING = YES
20401998
# The default value is: NO.
20411999
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
20422000

2043-
MACRO_EXPANSION = NO
2001+
MACRO_EXPANSION = YES
20442002

20452003
# If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES then
20462004
# the macro expansion is limited to the macros specified with the PREDEFINED and
20472005
# EXPAND_AS_DEFINED tags.
20482006
# The default value is: NO.
20492007
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
20502008

2051-
EXPAND_ONLY_PREDEF = NO
2009+
EXPAND_ONLY_PREDEF = YES
20522010

20532011
# If the SEARCH_INCLUDES tag is set to YES, the include files in the
20542012
# INCLUDE_PATH will be searched if a #include is found.
@@ -2080,7 +2038,19 @@ INCLUDE_FILE_PATTERNS =
20802038
# recursively expanded use the := operator instead of the = operator.
20812039
# This tag requires that the tag ENABLE_PREPROCESSING is set to YES.
20822040

2083-
PREDEFINED =
2041+
PREDEFINED = __DOXYGEN__ \
2042+
__thumb__ \
2043+
__thumb2__ \
2044+
__GNUC__ \
2045+
UVISOR_ENABLED \
2046+
UVISOR_PACKED= \
2047+
UVISOR_EXTERN:=extern \
2048+
UVISOR_ALIGN= \
2049+
UVISOR_FORCEINLINE:=inline \
2050+
UVISOR_WEAK= \
2051+
UVISOR_NORETURN= \
2052+
UVISOR_RAMFUNC=
2053+
20842054

20852055
# If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then this
20862056
# tag can be used to specify a list of macro names that should be expanded. The

0 commit comments

Comments
 (0)