Skip to content

Commit a441646

Browse files
committed
Fixes for wolfTPM documentation generation.
1 parent 62eff27 commit a441646

File tree

3 files changed

+17
-17
lines changed

3 files changed

+17
-17
lines changed

docs/Doxyfile

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -865,7 +865,14 @@ WARN_LOGFILE =
865865
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
866866
# Note: If this tag is empty the current directory is searched.
867867

868-
INPUT = ./docs/README.md ./wolftpm/tpm2.h ./wolftpm/tpm2_wrap.h ./hal/tpm_io.h
868+
INPUT = ./docs/README.md \
869+
./examples/README.md \
870+
./examples/pcr/README.md \
871+
./examples/attestation/README.md \
872+
./examples/boot/README.md \
873+
./wolftpm/tpm2.h \
874+
./wolftpm/tpm2_wrap.h \
875+
./hal/tpm_io.h
869876

870877
# This tag can be used to specify the character encoding of the source files
871878
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -954,7 +961,7 @@ RECURSIVE = NO
954961
# Note that relative paths are relative to the directory from which doxygen is
955962
# run.
956963

957-
EXCLUDE = ./examples
964+
EXCLUDE =
958965

959966
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
960967
# directories that are symbolic links (a Unix file system feature) are excluded
@@ -1162,13 +1169,6 @@ VERBATIM_HEADERS = YES
11621169

11631170
ALPHABETICAL_INDEX = YES
11641171

1165-
# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
1166-
# which the alphabetical index list will be split.
1167-
# Minimum value: 1, maximum value: 20, default value: 5.
1168-
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
1169-
1170-
COLS_IN_ALPHA_INDEX = 5
1171-
11721172
# In case all classes in a project start with a common prefix, all classes will
11731173
# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
11741174
# can be used to specify a prefix (or a list of prefixes) that should be ignored
@@ -2065,7 +2065,7 @@ MAN_LINKS = NO
20652065
# captures the structure of the code including all documentation.
20662066
# The default value is: NO.
20672067

2068-
GENERATE_XML = NO
2068+
GENERATE_XML = YES
20692069

20702070
# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
20712071
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of

docs/README.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ cd wolftpm
6363
make
6464
```
6565

66-
For detailed build instructions see [/README.md](/README.md#building).
66+
For detailed build instructions see [README.md](/README.md#building).
6767

6868
## Getting Started
6969

@@ -73,17 +73,17 @@ To interface with the hardware platform that is running these applications, plea
7373

7474
### Examples
7575

76-
See [/examples/README.md](/examples/README.md)
76+
See [examples/README.md](/examples/README.md)
7777

7878
### Benchmarks
7979

80-
See [/README.md](/README.md#tpm2-benchmarks)
80+
See [README.md](/README.md#tpm2-benchmarks)
8181

8282
## wolfTPM Library Design
8383

8484
### Library Headers
8585

86-
wolfTPM header files are located in [/wolftpm](/wolftpm).
86+
wolfTPM header files are located in [wolftpm](/wolftpm).
8787

8888
The general header files that should be included from wolfTPM is shown below:
8989

@@ -104,11 +104,11 @@ See [https://www.wolfssl.com/docs/wolftpm-manual/](https://www.wolfssl.com/docs/
104104

105105
### TPM 2.0 TCG API's
106106

107-
See [/wolftpm/tpm2.h](/wolftpm/tpm2.h) for inline doxygen style API documentation.
107+
See [wolftpm/tpm2.h](/wolftpm/tpm2.h) for inline doxygen style API documentation.
108108

109109
### wolfTPM Wrapper API's
110110

111-
See [/wolftpm/tpm2_wrap.h](/wolftpm/tpm2_wrap.h) for inline doxygen style API documentation.
111+
See [wolftpm/tpm2_wrap.h](/wolftpm/tpm2_wrap.h) for inline doxygen style API documentation.
112112

113113
## Support
114114

examples/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@ This example demonstrates the use of `authSession` (authorization Session) and `
3838

3939
Demonstrates the generation of TPM2.0 Quote used for attestation of the system state by putting PCR value(s) in a TPM signed structure.
4040

41-
More information about how to test and use PCR attestation can be found in the in [examples/pcr/README.md](./examples/pcr/README.md).
41+
More information about how to test and use PCR attestation can be found in the in [examples/pcr/README.md](/examples/pcr/README.md).
4242

4343
`./examples/pcr/quote`
4444
`./examples/pcr/extend`

0 commit comments

Comments
 (0)