#15228 closed defect (fixed)

Minor documentation fixes

Reported by: dghart Owned by: vadz
Priority: low Milestone: 2.9.5
Component: documentation Version: stable-latest
Keywords: Cc:
Blocked By: Blocking:
Patch: yes

Description

1) In the wxRichTextCtrl docs there are a few instances where the 'brief' description is truncated at an 'i.e.'

2) There's truncation for a different reason in the Typedefs section of http://docs.wxwidgets.org/trunk/group__group__funcmacro__string.html. It seems that a '-' at the beginning of a line needs to be escaped before it's translated into a bullet.

3) There are places in http://docs.wxwidgets.org/trunk/classwx_cmd_line_parser.html where '--' appears as '–'. Apparently recent doxygen versions do this, perhaps intentionally. The first hyphen needs to be escaped.

patch.diff fixes these.

Attachments (1)

patch.diff download (5.3 KB) - added by dghart 19 months ago.

Download all attachments as: .zip

Change History (3)

Changed 19 months ago by dghart

comment:1 Changed 19 months ago by vadz

  • Owner set to vadz
  • Status changed from new to accepted

Thanks a lot, will apply soon.

comment:2 Changed 19 months ago by VZ

  • Resolution set to fixed
  • Status changed from accepted to closed

(In [74064]) Fix for special characters in Doxygen comments.

Escape "-" characters in the beginning of the paragraph as they are not
handled properly by Doxygen otherwise.

Escape the space after "i.e." to prevent the brief doc string from being
terminated by it.

Escape "--" which is translated to a dash by Doxygen otherwise.

Closes #15228.

Note: See TracTickets for help on using tickets.