Report information
The Basics
Id:
46276
Status:
resolved
Priority:
Low/Low
Queue:
bind9-public
People
Owner:
Nobody in particular
Requestors:
Michał Kępień <michal@isc.org>
Cc:
AdminCc:
BugTracker
Version Fixed:
9.9.12, 9.10.7, 9.11.3, 9.12.0
Version Found:
(no value)
Versions Affected:
(no value)
Versions Planned:
(no value)
Priority:
P3 Low
Severity:
S3 Low
CVSS Score:
(no value)
CVE ID:
(no value)
Component:
BIND Documentation
Area:
bug
Dates
Created:Fri, 13 Oct 2017 09:10:43 -0400
Updated:Tue, 17 Oct 2017 02:47:10 -0400
Closed:Tue, 17 Oct 2017 02:47:10 -0400

This bug tracker is no longer active.

Please go to our Gitlab to submit issues (both feature requests and bug reports) for active projects maintained by Internet Systems Consortium (ISC).

Due to security and confidentiality requirements, full access is limited to the primary maintainers.

History
  Fri, 13 Oct 2017 09:10:43 -0400 Michał Kępień <michal@isc.org> - Ticket created
From: michal@isc.org
To: bind9-public@isc.org
Subject: Generate Doxygen documentation for all functions annotated with ISC_FORMAT_PRINTF()
Date: Fri, 13 Oct 2017 15:10:43 +0200

Functions annotated with ISC_FORMAT_PRINTF() which have documentation placed after them (using "/*!<" or "/*%<") are incorrectly preprocessed by Doxygen, which prevents documentation for such functions from being prepared.
  Fri, 13 Oct 2017 09:13:52 -0400 Michał Kępień <michal@isc.org> - Correspondence added

Proposed fix is in rt46276. It avoids wreaking havoc in generated documentation by enabling expansion only for explicitly specified macros. A cursory search through the source tree did not uncover any further candidates for special-casing like this, but if it turns out to be necessary, more macros may easily be added by following the examples from Doxygen documentation [1]. Please review. [1] http://www.doxygen.nl/config.html
Fri, 13 Oct 2017 09:13:53 -0400 Michał Kępień <michal@isc.org> - Status changed from 'open' to 'review'
Fri, 13 Oct 2017 09:13:53 -0400 Michał Kępień <michal@isc.org> - Untaken
  Tue, 17 Oct 2017 00:37:28 -0400 Mark Andrews <marka@isc.org> - Correspondence added

On Fri Oct 13 03:13:52 2017, michal wrote: > Proposed fix is in rt46276. It avoids wreaking havoc in generated > documentation by enabling expansion only for explicitly specified > macros. A cursory search through the source tree did not uncover any > further candidates for special-casing like this, but if it turns out to > be necessary, more macros may easily be added by following the examples > from Doxygen documentation [1]. > > Please review. > > [1] http://www.doxygen.nl/config.html LIBRPZ_PF is a similar macro. Silenced most of the errors from Doxygen. DNS_MESSAGETEXTFLAG_OMITDOT is still being warned about. We need to workout whether to implement or remove from the documentation. I'll open a seperate ticket to address this. Good too commit
Tue, 17 Oct 2017 02:47:09 -0400 Michał Kępień <michal@isc.org> - Version Fixed 9.9.12, 9.10.7, 9.11.3, 9.12.0 added
  Tue, 17 Oct 2017 02:47:09 -0400 Michał Kępień <michal@isc.org> - Correspondence added

4773. [doc] Fixed generating Doxygen documentation for functions annotated using certain macros. Miscellaneous Doxygen-related cleanups. [RT #46276] 9.9.12, 9.10.7, 9.11.3, 9.12.0
Tue, 17 Oct 2017 02:47:10 -0400 Michał Kępień <michal@isc.org> - Status changed from 'review' to 'resolved'
Tue, 17 Oct 2017 02:47:10 -0400 Michał Kępień <michal@isc.org> - Reference to #46295: DNS_MESSAGETEXTFLAG_OMITDOT: implement or remove from documention added