From ab9488559f5e86f8b25b7f43db7fb8a6f06126b5 Mon Sep 17 00:00:00 2001 From: Jon Shallow Date: Thu, 1 Sep 2022 20:14:45 +0100 Subject: [PATCH] Doxygen: Fix missing links for later versions of asciidoc Fix the link for the last entry in the name list where asciidoc converts the minus sign to an extended dash (em dash) Remove the updating of navtree.js as it is done differently in later versions of doxygen. Add in the missing name entry for coap_attribute. --- doc/Makefile.am | 14 +++++--------- man/coap_attribute.txt.in | 3 ++- 2 files changed, 7 insertions(+), 10 deletions(-) diff --git a/doc/Makefile.am b/doc/Makefile.am index e383d411..5a69f975 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -213,12 +213,14 @@ man-page-build: upg-page-build man-page-start ## for FILE in $${MAN_FILES} `cat $(top_builddir)/doc/scratch_insert_file` ; do \ ENTRY=`basename $${FILE} | cut -d . -f1` ;\ + ## Functions defined in the body $(SED) -i "s^\(\)\(coap[_-][0-9a-z_]*\)\((\|(\)^\1\2\3^g" $(top_builddir)/doc/man_html/$${ENTRY}.html ;\ - ## The NAME entries + ## The SYNOPSIS entries $(SED) -i "s^\(

[a-z0-9_ \*]*\)\(coap_[0-9a-z_]*\)\([(;]\)^\1\2\3^g" $(top_builddir)/doc/man_html/$${ENTRY}.html ;\ - $(SED) -i "s^\([ =,] \|[(!>]\|\^\)\(coap_[0-9a-z_]*\)\([(,]\| \-\)^\1\2\3^g" $(top_builddir)/doc/man_html/$${ENTRY}.html ;\ + ## Function in NAME and Examples + $(SED) -i "s^\([ =,] \|[(!>]\|\^\)\(coap_[0-9a-z_]*\)\([(,]\| \-\| \xe2\x80\x94\)^\1\2\3^g" $(top_builddir)/doc/man_html/$${ENTRY}.html ;\ ## Do for a second time in case of overlaps - $(SED) -i "s^\([ =,] \|[(!>]\|\^\)\(coap_[0-9a-z_]*\)\([(,]\| \-\)^\1\2\3^g" $(top_builddir)/doc/man_html/$${ENTRY}.html ;\ + $(SED) -i "s^\([ =,] \|[(!>]\|\^\)\(coap_[0-9a-z_]*\)\([(,]\| \-\| \xe2\x80\x94\)^\1\2\3^g" $(top_builddir)/doc/man_html/$${ENTRY}.html ;\ done ;\ ## ## Do the highlighting @@ -237,12 +239,6 @@ upg-page-build: all: man-page-build $(DOXYGEN) Doxyfile - ## - ## Process the list of individual man pages to update html/navtree.js - ## - @for ENTRY in `cat $(top_builddir)/doc/scratch_insert_file` ; do \ - ${SED} -i "s/man_$${ENTRY}.html/\0#$${ENTRY}/" $(top_builddir)/doc/html/navtree.js ;\ - done @$(RM) $(top_builddir)/doc/insert_file $(top_builddir)/doc/scratch_insert_file @cp -f $(top_srcdir)/doc/docbook.local.css $(top_builddir)/doc/html/docbook-xsl.css diff --git a/man/coap_attribute.txt.in b/man/coap_attribute.txt.in index 122057b3..52423150 100644 --- a/man/coap_attribute.txt.in +++ b/man/coap_attribute.txt.in @@ -12,7 +12,8 @@ NAME ---- coap_attribute, coap_add_attr, -coap_find_attr +coap_find_attr, +coap_attr_get_value - Work with CoAP attributes SYNOPSIS