swift-doc icon indicating copy to clipboard operation
swift-doc copied to clipboard

Comment tags are not recognized

Open b-onc opened this issue 3 years ago • 3 comments

Comment tags, such as Important, Note, Warning are not recognized and rendered as >.

Example:

/// Describes the ordering the messages are presented.
///
/// - Important: ⚠️ Changing this value doesn't trigger delegate methods. You should reload your UI manually after changing
/// the `listOrdering` value to reflect the changes. Further updates to the messages will be delivered using the delegate
/// methods, as usual.
///
public var listOrdering: ListOrdering = .topToBottom

rendered as: image

and generated markdown:

### `listOrdering`

Describes the ordering the messages are presented.

``` swift
public var listOrdering: ListOrdering = .topToBottom 
\```

> 

(escaped the closing backticks of the code snippet intentionally)

b-onc avatar Jun 07 '21 12:06 b-onc

@b-onc What version are you using? This should be in the latest release (1.0.0-rc.1) with #282

$ swift-doc --version

mattt avatar Jun 09 '21 22:06 mattt

Hello @mattt ,

the PR you sent is currently working only for HTML style of documentation, however I didn't find anything in the PR that would be related to the output for markdown files. Could you please take a look into this issue?

Thank you very much

DominikBucher12 avatar Jun 10 '21 07:06 DominikBucher12

@DominikBucher12 Thanks for pointing this out. I can confirm that this isn't working as intended: https://github.com/SwiftDocOrg/SwiftMarkup/wiki/Callout_Delimiter

mattt avatar Jun 10 '21 11:06 mattt