gtkd-developers / GtkD

GtkD is a D binding and OO wrapper of GTK+ originally created by Antonio Monteiro
http://gtkd.org
Other
322 stars 71 forks source link

Unusually quoted words in documentation comments #155

Open Hackerpilot opened 8 years ago

Hackerpilot commented 8 years ago

The GtkD code contains things like this in doc comments:

/// `'type'`

The behavior of ddoc (See the "inline code" section of http://dlang.org/spec/ddoc.html) is to interpret text inside of '' characters as D code, which for some documentation generators involves lexing the code between '' characters. The lexer will then see the single quote as the beginning of a character literal and error out when it finds more than one character inside of the single quotes.