1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
|
Author: Laszlo Kajan <lkajan@rostlab.org>
Description: generate documentation
Forwarded: http://lists.alioth.debian.org/pipermail/debian-med-packaging/2012-August/016975.html
--- a/etc/Doxyfile-template
+++ b/etc/Doxyfile-template
@@ -123,7 +123,7 @@ INLINE_INHERITED_MEMB = NO
# path before files name in the file list and in the header files. If set
# to NO the shortest path that makes the file name unique will be used.
-FULL_PATH_NAMES = NO
+FULL_PATH_NAMES = YES
# If the FULL_PATH_NAMES tag is set to YES then the STRIP_FROM_PATH tag
# can be used to strip a user-defined part of the path. Stripping is
@@ -250,7 +250,7 @@ EXTRACT_ALL = YES
# If the EXTRACT_PRIVATE tag is set to YES all private members of a class
# will be included in the documentation.
-EXTRACT_PRIVATE = YES
+EXTRACT_PRIVATE = NO
# If the EXTRACT_STATIC tag is set to YES all static members of a file
# will be included in the documentation.
@@ -423,26 +423,26 @@ FILE_VERSION_FILTER =
# The QUIET tag can be used to turn on/off the messages that are generated
# by doxygen. Possible values are YES and NO. If left blank NO is used.
-QUIET = NO
+QUIET = YES
# The WARNINGS tag can be used to turn on/off the warning messages that are
# generated by doxygen. Possible values are YES and NO. If left blank
# NO is used.
-WARNINGS = YES
+WARNINGS = NO
# If WARN_IF_UNDOCUMENTED is set to YES, then doxygen will generate warnings
# for undocumented members. If EXTRACT_ALL is set to YES then this flag will
# automatically be disabled.
-WARN_IF_UNDOCUMENTED = YES
+WARN_IF_UNDOCUMENTED = NO
# If WARN_IF_DOC_ERROR is set to YES, doxygen will generate warnings for
# potential errors in the documentation, such as not documenting some
# parameters in a documented function, or documenting parameters that
# don't exist or using markup commands wrongly.
-WARN_IF_DOC_ERROR = YES
+WARN_IF_DOC_ERROR = NO
# This WARN_NO_PARAMDOC option can be abled to get warnings for
# functions that are documented, but have no documentation for their parameters
@@ -798,7 +798,7 @@ TREEVIEW_WIDTH = 250
# If the GENERATE_LATEX tag is set to YES (the default) Doxygen will
# generate Latex output.
-GENERATE_LATEX = YES
+GENERATE_LATEX = NO
# The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put.
# If a relative path is entered the value of OUTPUT_DIRECTORY will be
--- a/Makefile
+++ b/Makefile
@@ -115,10 +115,19 @@ clean_test:
###
doc:
- @sh -c 'cd ./$(UTIL_MODULE); ./$(DOC_SCRIPT)'
+ rm -rf rcsb && cp -r include rcsb
+ grep -lr '^#include "' rcsb | xargs sed -i -e '/^#include "/{ s/#include "\([^"]\+\)"/#include <rcsb\/\1>/; }'
+ mkdir -p docs/doxyfiles
+ echo PROJECT_NAME = librcsb-core-wrapper > docs/doxyfiles/Doxyfile
+ echo PROJECT_NUMBER = $(shell dpkg-parsechangelog | grep '^Version' | sed -e 's/Version: \(.*\)-[^-]\+$$/\1/g;') >> docs/doxyfiles/Doxyfile
+ echo OUTPUT_DIRECTORY = docs >> docs/doxyfiles/Doxyfile
+ echo INPUT = rcsb >> docs/doxyfiles/Doxyfile
+ cat etc/Doxyfile-template >> docs/doxyfiles/Doxyfile
+ doxygen docs/doxyfiles/Doxyfile
clean_doc:
- @sh -c 'cd ./$(UTIL_MODULE); ./$(CLEAN_DOC_SCRIPT)'
+ rm -rf docs
+ rm -rf rcsb
export: clean
@sh -c 'cd ./$(UTIL_MODULE); ./$(EXPORT_SCRIPT)'
|
