Modify

Opened 8 years ago

Closed 8 years ago

#3242 closed Bugs (fixed)

Enum values can't be made internal with doxygen to boostbook

Reported by: anonymous Owned by: Daniel James
Milestone: Boost 1.40.0 Component: Documentation
Version: Boost 1.39.0 Severity: Cosmetic
Keywords: boostbook doxygen Cc: loufoque@…

Description

Commenting an enum value with INTERNAL ONLY does not prevent the enum value from appearing in the generated boostbook documentation, while it does work when commenting functions, variables or macros.

Attachments (1)

enum_internal_doxygen.diff (1.9 KB) - added by Mathias Gaunard <loufoque@…> 8 years ago.
Patch to ignore enumvalue's which have INTERNAL ONLY in their description

Download all attachments as: .zip

Change History (5)

comment:1 Changed 8 years ago by loufoque@…

Component: NoneDocumentation
Owner: set to Matias Capeletto

comment:2 Changed 8 years ago by Mathias Gaunard <loufoque@…>

Cc: loufoque@… added
Keywords: boostbook doxygen added

Changed 8 years ago by Mathias Gaunard <loufoque@…>

Attachment: enum_internal_doxygen.diff added

Patch to ignore enumvalue's which have INTERNAL ONLY in their description

comment:3 Changed 8 years ago by Daniel James

Owner: changed from Matias Capeletto to Daniel James
Status: newassigned

comment:4 Changed 8 years ago by Daniel James

Resolution: fixed
Status: assignedclosed

(In [54910]) Merge changes to documentation tools. Fixes #1202, #3242.

Merged revisions 54812-54818 via svnmerge from https://svn.boost.org/svn/boost/trunk

........

r54812 | danieljames | 2009-07-08 22:40:14 +0100 (Wed, 08 Jul 2009) | 1 line

Add a couple of tests for quickbook 1.4 behaviour to try to preserve it.

........

r54813 | danieljames | 2009-07-08 22:40:24 +0100 (Wed, 08 Jul 2009) | 1 line

Move all the syntax highlighting code into a single class.

........

r54814 | danieljames | 2009-07-08 22:40:33 +0100 (Wed, 08 Jul 2009) | 1 line

Move the code actions a bit later in actions.hpp so they can use 'plain_char_action'.

........

r54815 | danieljames | 2009-07-08 22:40:46 +0100 (Wed, 08 Jul 2009) | 1 line

Teletype source mode. Refs #1202.

........

r54816 | danieljames | 2009-07-08 22:41:00 +0100 (Wed, 08 Jul 2009) | 14 lines

Make sure that a template expansion ends with a ']'.

[template foo 1]
[fool]

was generating 1[fool] - the template would be expanded but then when it didn't match the ] it would fail and just get copied to the output. This change checks for ] before expanding the template. So it now generates [fool] which is an improvement.

I'm not including a version switch as I see this as a plain bug fix - I can't imagine this change ever being anything but beneficial.

........

r54817 | danieljames | 2009-07-08 22:41:10 +0100 (Wed, 08 Jul 2009) | 1 line

I got a bit confused by this comment, so try to make it clearer.

........

r54818 | danieljames | 2009-07-08 22:53:15 +0100 (Wed, 08 Jul 2009) | 3 lines

Support INTERNAL ONLY enums in doxygen/boostbook documenation. Refs #3242.

Patch by Mathias Gaunard.

........

Modify Ticket

Change Properties
Set your email in Preferences
Action
as closed The owner will remain Daniel James.
The resolution will be deleted.

Add Comment


E-mail address and name can be saved in the Preferences.

 
Note: See TracTickets for help on using tickets.