Skip to content

Commit ddd483b

Browse files
committed
change some doxygen defaults
1 parent e874e1b commit ddd483b

File tree

4 files changed

+1217
-23
lines changed

4 files changed

+1217
-23
lines changed

.gitignore

+3-1
Original file line numberDiff line numberDiff line change
@@ -1 +1,3 @@
1-
.DS_Store
1+
.DS_Store
2+
*.esproj
3+
/html

Doxyfile

+17-17
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ DOXYFILE_ENCODING = UTF-8
2626
# identify the project. Note that if you do not use Doxywizard you need
2727
# to put quotes around the project name if it contains spaces.
2828

29-
PROJECT_NAME = "Jeelib"
29+
PROJECT_NAME = "JeeLib"
3030

3131
# The PROJECT_NUMBER tag can be used to enter a project or revision number.
3232
# This could be handy for archiving the generated documentation or
@@ -38,7 +38,7 @@ PROJECT_NUMBER =
3838
# for a project that appears at the top of each page and should give viewer
3939
# a quick idea about the purpose of the project. Keep the description short.
4040

41-
PROJECT_BRIEF = "An easy interface to the port headers, the RF12 driver library, timers, low-power code, and more"
41+
PROJECT_BRIEF = "An easy interface to the port headers, the RF12 driver library, timers, low-power code, and more."
4242

4343
# With the PROJECT_LOGO tag one can specify an logo or icon that is
4444
# included in the documentation. The maximum height of the logo should not
@@ -238,7 +238,7 @@ OPTIMIZE_OUTPUT_VHDL = NO
238238
# (default is Fortran), use: inc=Fortran f=C. Note that for custom extensions
239239
# you also need to set FILE_PATTERNS otherwise the files are not read by doxygen.
240240

241-
EXTENSION_MAPPING =
241+
EXTENSION_MAPPING = Markdown=md
242242

243243
# If MARKDOWN_SUPPORT is enabled (the default) then doxygen pre-processes all
244244
# comments according to the Markdown format, which allows for more readable
@@ -355,27 +355,27 @@ LOOKUP_CACHE_SIZE = 0
355355
# Private class members and static file members will be hidden unless
356356
# the EXTRACT_PRIVATE and EXTRACT_STATIC tags are set to YES
357357

358-
EXTRACT_ALL = YES
358+
EXTRACT_ALL = NO
359359

360360
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
361361
# will be included in the documentation.
362362

363-
EXTRACT_PRIVATE = YES
363+
EXTRACT_PRIVATE = NO
364364

365365
# If the EXTRACT_PACKAGE tag is set to YES all members with package or internal scope will be included in the documentation.
366366

367-
EXTRACT_PACKAGE = YES
367+
EXTRACT_PACKAGE = NO
368368

369369
# If the EXTRACT_STATIC tag is set to YES all static members of a file
370370
# will be included in the documentation.
371371

372-
EXTRACT_STATIC = YES
372+
EXTRACT_STATIC = NO
373373

374374
# If the EXTRACT_LOCAL_CLASSES tag is set to YES classes (and structs)
375375
# defined locally in source files will be included in the documentation.
376376
# If set to NO only classes defined in header files are included.
377377

378-
EXTRACT_LOCAL_CLASSES = YES
378+
EXTRACT_LOCAL_CLASSES = NO
379379

380380
# This flag is only useful for Objective-C code. When set to YES local
381381
# methods, which are defined in the implementation section but not in
@@ -608,7 +608,7 @@ CITE_BIB_FILES =
608608
# The QUIET tag can be used to turn on/off the messages that are generated
609609
# by doxygen. Possible values are YES and NO. If left blank NO is used.
610610

611-
QUIET = NO
611+
QUIET = YES
612612

613613
# The WARNINGS tag can be used to turn on/off the warning messages that are
614614
# generated by doxygen. Possible values are YES and NO. If left blank
@@ -620,7 +620,7 @@ WARNINGS = YES
620620
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
621621
# automatically be disabled.
622622

623-
WARN_IF_UNDOCUMENTED = YES
623+
WARN_IF_UNDOCUMENTED = NO
624624

625625
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
626626
# potential errors in the documentation, such as not documenting some
@@ -661,7 +661,7 @@ WARN_LOGFILE =
661661
# directories like "/usr/src/myproject". Separate the files or directories
662662
# with spaces.
663663

664-
INPUT =
664+
INPUT =
665665

666666
# This tag can be used to specify the character encoding of the source files
667667
# that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
@@ -679,7 +679,7 @@ INPUT_ENCODING = UTF-8
679679
# *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py
680680
# *.f90 *.f *.for *.vhd *.vhdl
681681

682-
FILE_PATTERNS = *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.dox *.py *.f90 *.f *.for *.vhd *.vhdl *.ino
682+
FILE_PATTERNS = *.c *.cc *.cxx *.cpp *.c++ *.d *.java *.ii *.ixx *.ipp *.i++ *.inl *.h *.hh *.hxx *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.md *.mm *.dox *.py *.f90 *.f *.for *.vhd *.vhdl *.ino
683683

684684
# The RECURSIVE tag can be used to turn specify whether or not subdirectories
685685
# should be searched for input files as well. Possible values are YES and NO.
@@ -793,7 +793,7 @@ SOURCE_BROWSER = NO
793793
# Setting the INLINE_SOURCES tag to YES will include the body
794794
# of functions and classes directly in the documentation.
795795

796-
INLINE_SOURCES = YES
796+
INLINE_SOURCES = NO
797797

798798
# Setting the STRIP_CODE_COMMENTS tag to YES (the default) will instruct
799799
# doxygen to hide any special comment blocks from generated source code
@@ -905,7 +905,7 @@ HTML_FOOTER =
905905
# the style sheet file to the HTML output directory, so don't put your own
906906
# style sheet in the HTML output directory as well, or it will be erased!
907907

908-
HTML_STYLESHEET =
908+
HTML_STYLESHEET = Doxygen.css
909909

910910
# The HTML_EXTRA_FILES tag can be used to specify one or more extra images or
911911
# other source files which should be copied to the HTML output directory. Note
@@ -1118,7 +1118,7 @@ ECLIPSE_DOC_ID = org.doxygen.Project
11181118
# navigation tree you can set this option to NO if you already set
11191119
# GENERATE_TREEVIEW to YES.
11201120

1121-
DISABLE_INDEX = NO
1121+
DISABLE_INDEX = YES
11221122

11231123
# The GENERATE_TREEVIEW tag is used to specify whether a tree-like index
11241124
# structure should be generated to display hierarchical information.
@@ -1130,7 +1130,7 @@ DISABLE_INDEX = NO
11301130
# Since the tree basically has the same information as the tab index you
11311131
# could consider to set DISABLE_INDEX to NO when enabling this option.
11321132

1133-
GENERATE_TREEVIEW = NO
1133+
GENERATE_TREEVIEW = YES
11341134

11351135
# The ENUM_VALUES_PER_LINE tag can be used to set the number of enum values
11361136
# (range [0,1..20]) that doxygen will group on one line in the generated HTML
@@ -1224,7 +1224,7 @@ SERVER_BASED_SEARCH = NO
12241224
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
12251225
# generate Latex output.
12261226

1227-
GENERATE_LATEX = YES
1227+
GENERATE_LATEX = NO
12281228

12291229
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
12301230
# If a relative path is entered the value of OUTPUT_DIRECTORY will be

0 commit comments

Comments
 (0)