Skip to content

Fix broken struct/class API pages and doc links #272

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
cconlon wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Fix broken struct/class API pages and doc links #272

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 6 additions & 0 deletions wolfHSM/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,6 +100,12 @@ pdf-setup: wolfhsm-update builddir
.PHONY: html-prep
html-prep: api
$(Q)cp -a api/md/*8h* build/html/
$(Q)cp -a api/md/Classes build/html/
$(Q)perl -i -pe 's#\]\(/Classes/#](#g' build/html/Classes/*.md
$(Q)perl -i -pe "s/Classes\///g" build/html/Classes/*.md
$(Q)perl -i -pe 's#\]\(/#](../#g' build/html/Classes/*.md
Comment thread
cconlon marked this conversation as resolved.
$(Q)perl -i -pe 's#\]\(/#](#g' build/html/*8h*
$(Q)perl -i -pe "s/(\]\([^)#]*#[a-z]+-)([^)]+?)(\))/\$$1.(\$$2=~tr#-#_#r).\$$3/ge" build/html/*8h* build/html/Classes/*.md

$(Q)perl -i -pe "s/\/group_/group_/g" build/html/group* build/html/*8h*
$(Q)perl -i -pe "s/dox_comments\/header_files\///" build/html/*8h*
Expand Down
1 change: 1 addition & 0 deletions wolfHSM/doxybook.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
"folderGroupsName": "",
"folderFilesName": "",
"foldersToGenerate": [
"classes",
"modules",
"files"
]
Expand Down
15 changes: 8 additions & 7 deletions wolfMQTT/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,15 @@ api: wolfmqtt-update
.PHONY: html-prep
html-prep: api
$(Q)cp -a api/md/*8h* build/html/
$(Q)cp -a api/md/Classes build/html/
$(Q)rm -rf build/html/chapter05.md
$(Q)perl -i -pe "s/Classes\///g" build/html/*8h*
$(Q)perl -i -pe "s/(?<=md\#function\-)(.*)(?=\))/\$$1=~s#-#_#gr/ge" build/html/*8h*
$(Q)perl -i -pe "s/(?<=md\#typedef\-)(.*)(?=\))/\$$1=~s#-#_#gr/ge" build/html/*8h*
$(Q)perl -i -pe "s/(?<=md\#enum\-)(.*)(?=\))/\$$1=~s#-#_#gr/ge" build/html/*8h*
$(Q)perl -i -pe "s/\\\\discussion//g" build/html/*8h*
$(Q)perl -i -pe "s/\/mqtt_/mqtt_/g" build/html/*8h*
$(Q)perl -i -pe "s/dox_comments\/header_files\///" build/html/*8h*
$(Q)perl -i -pe "s/\\\\discussion//g" build/html/*8h* build/html/Classes/*.md
$(Q)perl -i -pe "s/dox_comments\/header_files\///" build/html/*8h* build/html/Classes/*.md
$(Q)perl -i -pe 's#\]\(/#](#g' build/html/*8h*
$(Q)perl -i -pe 's#\]\(/Classes/#](#g' build/html/Classes/*.md
$(Q)perl -i -pe "s/Classes\///g" build/html/Classes/*.md
$(Q)perl -i -pe 's#\]\(/#](../#g' build/html/Classes/*.md
Comment thread
cconlon marked this conversation as resolved.
$(Q)perl -i -pe "s/(\]\([^)#]*#[a-z]+-)([^)]+?)(\))/\$$1.(\$$2=~tr#-#_#r).\$$3/ge" build/html/*8h* build/html/Classes/*.md
Comment thread
cconlon marked this conversation as resolved.

# Set input format to gfm to fix issues with converted API docs
# Regexes:
Expand Down
1 change: 1 addition & 0 deletions wolfMQTT/doxybook.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
"folderGroupsName": "",
"folderFilesName": "",
"foldersToGenerate": [
"classes",
"modules",
"files"
]
Expand Down
1 change: 1 addition & 0 deletions wolfSSL/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,7 @@ html-prep: api
$(Q)rm -f build/html/appendix01.md build/html/appendix02.md build/html/appendix03.md
$(Q)perl -i -pe "s/(?<=md\#function\-)(.*)(?=\))/\$$1=~s#-#_#gr/ge" build/html/group* build/html/*8h*
$(Q)perl -i -pe "s/\/group_/group_/g" build/html/group* build/html/*8h*
$(Q)perl -i -pe 's#\]\(/#](#g' build/html/group* build/html/*8h*
$(Q)perl -i -pe "s/dox_comments\/$(HEADER_FILES)\///" build/html/*8h*

# Set input format to gfm to fix issues with converted API docs
Expand Down
6 changes: 6 additions & 0 deletions wolfTPM/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,12 @@ html-prep: api
else
$(Q)cp -a api/md/group* build/html/
$(Q)cp -a api/md/*8h* build/html/
$(Q)cp -a api/md/Classes build/html/
$(Q)perl -i -pe 's#\]\(/Classes/#](#g' build/html/Classes/*.md
$(Q)perl -i -pe "s/Classes\///g" build/html/Classes/*.md
Comment thread
cconlon marked this conversation as resolved.
$(Q)perl -i -pe 's#\]\(/#](../#g' build/html/Classes/*.md
Comment thread
cconlon marked this conversation as resolved.
$(Q)perl -i -pe 's#\]\(/#](#g' build/html/group* build/html/*8h*
$(Q)perl -i -pe "s/(\]\([^)#]*#[a-z]+-)([^)]+?)(\))/\$$1.(\$$2=~tr#-#_#r).\$$3/ge" build/html/group* build/html/*8h* build/html/Classes/*.md
endif

$(Q)rm -rf build/html/chapter05.md
Expand Down
1 change: 1 addition & 0 deletions wolfTPM/doxybook.cfg
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
"folderGroupsName": "",
"folderFilesName": "",
"foldersToGenerate": [
"classes",
"modules",
"files"
]
Expand Down
Loading