Skip to content

Commit 2c912a9

Browse files
author
Bridger Voss
committed
fixed/added API reference and fixed pdf build
1 parent d5e5328 commit 2c912a9

File tree

3 files changed

+6
-3
lines changed

3 files changed

+6
-3
lines changed

wolfHSM/Doxyfile

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -867,6 +867,7 @@ WARN_LOGFILE =
867867

868868
INPUT = README.md \
869869
wolfhsm/wh_client.h \
870+
wolfhsm/wh_client_crypto.h \
870871
wolfhsm/wh_server.h
871872

872873
# This tag can be used to specify the character encoding of the source files
@@ -983,7 +984,8 @@ EXCLUDE_PATTERNS =
983984
# Note that the wildcards are matched against the file with absolute path, so to
984985
# exclude all test directories use the pattern */test/*
985986

986-
EXCLUDE_SYMBOLS =
987+
EXCLUDE_SYMBOLS = whServer* WH_SERVER_* wh_server_* \
988+
whClient* WH_CLIENT_* wh_client_*
987989

988990
# The EXAMPLE_PATH tag can be used to specify one or more files or directories
989991
# that contain example code fragments that are included (see the \include
@@ -1179,7 +1181,7 @@ IGNORE_PREFIX =
11791181
# If the GENERATE_HTML tag is set to YES, doxygen will generate HTML output
11801182
# The default value is: YES.
11811183

1182-
GENERATE_HTML = YES
1184+
GENERATE_HTML = NO
11831185

11841186
# The HTML_OUTPUT tag is used to specify where the HTML docs will be put. If a
11851187
# relative path is entered the value of OUTPUT_DIRECTORY will be put in front of

wolfHSM/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -77,4 +77,4 @@ pdf-prep: api
7777
$(Q)perl -i -pe "s/(?<=md\#function\-)(.*)(?=\))/\$$1=~s#-#_#gr/ge" build/pdf/*.md
7878
$(Q)perl -i -pe "s/(?<=md\#typedef\-)(.*)(?=\))/\$$1=~s#-#_#gr/ge" build/pdf/*.md
7979
$(Q)perl -i -pe "s/(?<=md\#enum\-)(.*)(?=\))/\$$1=~s#-#_#gr/ge" build/pdf/*.md
80-
80+
$(Q)cat build/pdf/wh__client_8h.md build/pdf/wh__client__crypto_8h.md build/pdf/wh__server_8h.md >> build/pdf/appendix01.md

wolfHSM/mkdocs.yml

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,7 @@ nav:
1414
- "8. Porting wolfHSM": chapter08.md
1515
- "9. API Reference":
1616
- Client API: wh__client_8h.md
17+
- Client Crypto API: wh__client__crypto_8h.md
1718
- Server API: wh__server_8h.md
1819
theme:
1920
name: null

0 commit comments

Comments
 (0)