diff options
-rw-r--r-- | .gitignore | 2 | ||||
-rw-r--r-- | doc/Makefile | 15 | ||||
-rw-r--r-- | doc/devel/doxyfile.in | 8 | ||||
-rw-r--r-- | doc/devel/mainpage.dox | 9 |
4 files changed, 28 insertions, 6 deletions
@@ -1,4 +1,4 @@ *.o bind -doc/devel/html +doc/html .deps diff --git a/doc/Makefile b/doc/Makefile index 229a0c57..60a48fdf 100644 --- a/doc/Makefile +++ b/doc/Makefile @@ -27,3 +27,18 @@ References.txt: References.xml References.html: References.xml xml2html References.xml +devel: + mkdir -p html + doxygen devel/doxyfile > html/doxygen.log 2>html/doxygen-warnings.log + +cppcheck: + mkdir -p html + cd .. && cppcheck --enable=all --inline-suppr \ + -f -v -j 2 -i tests/ -i dhcp-*/ \ + . 1> doc/html/cppcheck.log 2> doc/html/cppcheck-error.log + +# cppcheck can be extended with list of suppressions. +# --suppressions-list=doc/cppcheck-skip.txt \ + + +.PHONY: devel cppcheck
\ No newline at end of file diff --git a/doc/devel/doxyfile.in b/doc/devel/doxyfile.in index 8f3db1a1..3ff0762d 100644 --- a/doc/devel/doxyfile.in +++ b/doc/devel/doxyfile.in @@ -45,7 +45,7 @@ PROJECT_BRIEF = "A reference DHCPv4 and DHCPv6 implementation" # exceed 55 pixels and the maximum width should not exceed 200 pixels. # Doxygen will copy the logo to the output directory. -PROJECT_LOGO = isc-logo.jpg +PROJECT_LOGO = devel/isc-logo.jpg # The OUTPUT_DIRECTORY tag is used to specify the (relative or absolute) # base path where the generated documentation will be put. @@ -655,7 +655,7 @@ WARN_LOGFILE = doxygen-warnings.log # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = ../.. +INPUT = .. # This tag can be used to specify the character encoding of the source files # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is @@ -1115,7 +1115,7 @@ ECLIPSE_DOC_ID = org.doxygen.Project # navigation tree you can set this option to NO if you already set # GENERATE_TREEVIEW to YES. -DISABLE_INDEX = NO +DISABLE_INDEX = YES # The GENERATE_TREEVIEW tag is used to specify whether a tree-like index # structure should be generated to display hierarchical information. @@ -1475,7 +1475,7 @@ ENABLE_PREPROCESSING = YES # compilation will be performed. Macro expansion can be done in a controlled # way by setting EXPAND_ONLY_PREDEF to YES. -MACRO_EXPANSION = YES +MACRO_EXPANSION = NO # If the EXPAND_ONLY_PREDEF and MACRO_EXPANSION tags are both set to YES # then the macro expansion is limited to the macros specified with the diff --git a/doc/devel/mainpage.dox b/doc/devel/mainpage.dox index 310842b6..8f784ef1 100644 --- a/doc/devel/mainpage.dox +++ b/doc/devel/mainpage.dox @@ -10,5 +10,12 @@ @section toc Table Of Contents - @subpage tests - @subpage debug - + + Doxygen logs: + + Note: some of the links below may not work if corresponding logs are not available.<br/> + + Doxygen: <a href="doxygen.log">[generation log]</a> <a href="doxygen-warnings.log">[errors and warnings]</a> <br/> + cppcheck: <a href="cppcheck.log">[generation log]</a> <a href="cppcheck-error.log">[errors and warnings]</a> <br/> + */
\ No newline at end of file |