Skip to content

Commit

Permalink
doc: Support hyper-linking to defined structures for man pages
Browse files Browse the repository at this point in the history
  • Loading branch information
mrdeep1 committed Mar 15, 2024
1 parent b332a18 commit e3f7dbe
Show file tree
Hide file tree
Showing 3 changed files with 9 additions and 1 deletion.
6 changes: 5 additions & 1 deletion doc/Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -133,7 +133,11 @@ man-page-build: upg-page-build man-page-start
echo "/// @page man_$${ENTRY} $${MANUAL}" > $(top_builddir)/doc/man_tmp/$${MANUAL}.dox ;\
echo "/// @htmlinclude $${ENTRY}.html $${MANUAL}" >> $(top_builddir)/doc/man_tmp/$${MANUAL}.dox ;\
## Create html file
cat $(top_builddir)/man/$${BASE}.html | ${SED} "s/Function: $${ENTRY}(/<a class=\"anchor\" id=\"$${ENTRY}\"><\/a>\0/" > $(top_builddir)/doc/man_html/$${ENTRY}.html ;\
cat $(top_builddir)/man/$${BASE}.html |\
${SED} "s/Function: $${ENTRY}(/<a class=\"anchor\" id=\"$${ENTRY}\"><\/a>\0/" |\
${SED} "s/Structure $${ENTRY}</<a class=\"anchor\" id=\"$${ENTRY}\"><\/a>\0/" |\
${SED} "s/SECTION: [A-Za-z /]*: $${ENTRY}</<a class=\"anchor\" id=\"$${ENTRY}\"><\/a>\0/" \
> $(top_builddir)/doc/man_html/$${ENTRY}.html ;\
## Update scratch_insert_file for sorting later
echo "$${ENTRY}" >> $(top_builddir)/doc/scratch_insert_file ;\
done ;\
Expand Down
1 change: 1 addition & 0 deletions man/Makefile.am
Original file line number Diff line number Diff line change
Expand Up @@ -103,6 +103,7 @@ A2X_EXTRA_PAGES_5 = @DOLLAR_SIGN@(shell for fil in $(TXT5) ; do sed -ne '/^NAME/
# Then all the alternative names as well as the extras defined below need
# to be cleaned up in a 'make unistall'.
install-man: install-man3 install-man5 install-man7
@echo ".so man3/coap_address.3" > coap_resolve_address_info.3
@echo ".so man3/coap_address.3" > coap_free_address_info.3
@echo ".so man3/coap_address.3" > coap_sockaddr_un.3
@echo ".so man3/coap_address.3" > coap_address_set_unix_domain.3
Expand Down
3 changes: 3 additions & 0 deletions man/coap_address.txt.in
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,7 @@ coap_address_equals,
coap_address_get_port,
coap_address_set_port,
coap_get_available_scheme_hint_bits,
coap_addr_info_t,
coap_resolve_address_info,
coap_free_address_info,
coap_sockaddr_un,
Expand All @@ -34,6 +35,8 @@ SYNOPSIS

*struct coap_address_t;*

*struct coap_addr_info_t;*

*struct coap_sockaddr_un;*

*void coap_address_init(coap_address_t *_addr_);*
Expand Down

0 comments on commit e3f7dbe

Please sign in to comment.