WolfSSL
/
wolfTPM
mirror of https://github.com/wolfSSL/wolfTPM.git
1
0
Fork 0
Code Issues Releases Wiki Activity

Fixes for wolfTPM documentation generation.

pull/363/head
David Garske 2024-07-30 14:52:34 -07:00
parent 62eff27459
commit a441646682
3 changed files with 17 additions and 17 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
docs/Doxyfile
View File

@ -865,7 +865,14 @@ WARN_LOGFILE =
# spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
# Note: If this tag is empty the current directory is searched.
INPUT = ./docs/README.md ./wolftpm/tpm2.h ./wolftpm/tpm2_wrap.h ./hal/tpm_io.h
INPUT = ./docs/README.md \
./examples/README.md \
./examples/pcr/README.md \
./examples/attestation/README.md \
./examples/boot/README.md \
./wolftpm/tpm2.h \
./wolftpm/tpm2_wrap.h \
./hal/tpm_io.h
# This tag can be used to specify the character encoding of the source files
# that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@ -954,7 +961,7 @@ RECURSIVE = NO
# Note that relative paths are relative to the directory from which doxygen is
# run.
EXCLUDE = ./examples
EXCLUDE =
# The EXCLUDE_SYMLINKS tag can be used to select whether or not files or
# directories that are symbolic links (a Unix file system feature) are excluded
@ -1162,13 +1169,6 @@ VERBATIM_HEADERS = YES
ALPHABETICAL_INDEX = YES
# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in
# which the alphabetical index list will be split.
# Minimum value: 1, maximum value: 20, default value: 5.
# This tag requires that the tag ALPHABETICAL_INDEX is set to YES.
COLS_IN_ALPHA_INDEX = 5
# In case all classes in a project start with a common prefix, all classes will
# be put under the same header in the alphabetical index. The IGNORE_PREFIX tag
# can be used to specify a prefix (or a list of prefixes) that should be ignored
@ -2065,7 +2065,7 @@ MAN_LINKS = NO
# captures the structure of the code including all documentation.
# The default value is: NO.
GENERATE_XML = NO
GENERATE_XML = YES
# The XML_OUTPUT tag is used to specify where the XML pages will be put. If a
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of

12
docs/README.md
View File

@ -63,7 +63,7 @@ cd wolftpm
make
```
For detailed build instructions see [/README.md](/README.md#building).
For detailed build instructions see [README.md](/README.md#building).
## Getting Started
@ -73,17 +73,17 @@ To interface with the hardware platform that is running these applications, plea
### Examples
See [/examples/README.md](/examples/README.md)
See [examples/README.md](/examples/README.md)
### Benchmarks
See [/README.md](/README.md#tpm2-benchmarks)
See [README.md](/README.md#tpm2-benchmarks)
## wolfTPM Library Design
### Library Headers
wolfTPM header files are located in [/wolftpm](/wolftpm).
wolfTPM header files are located in [wolftpm](/wolftpm).
The general header files that should be included from wolfTPM is shown below:
@ -104,11 +104,11 @@ See [https://www.wolfssl.com/docs/wolftpm-manual/](https://www.wolfssl.com/docs/
### TPM 2.0 TCG API's
See [/wolftpm/tpm2.h](/wolftpm/tpm2.h) for inline doxygen style API documentation.
See [wolftpm/tpm2.h](/wolftpm/tpm2.h) for inline doxygen style API documentation.
### wolfTPM Wrapper API's
See [/wolftpm/tpm2_wrap.h](/wolftpm/tpm2_wrap.h) for inline doxygen style API documentation.
See [wolftpm/tpm2_wrap.h](/wolftpm/tpm2_wrap.h) for inline doxygen style API documentation.
## Support

2
examples/README.md
View File

@ -38,7 +38,7 @@ This example demonstrates the use of `authSession` (authorization Session) and `
Demonstrates the generation of TPM2.0 Quote used for attestation of the system state by putting PCR value(s) in a TPM signed structure.
More information about how to test and use PCR attestation can be found in the in [examples/pcr/README.md](./examples/pcr/README.md).
More information about how to test and use PCR attestation can be found in the in [examples/pcr/README.md](/examples/pcr/README.md).
`./examples/pcr/quote`
`./examples/pcr/extend`