Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Support simple markdown in comments #6

Closed
a-kramer opened this issue Nov 15, 2019 · 5 comments
Closed

Support simple markdown in comments #6

a-kramer opened this issue Nov 15, 2019 · 5 comments
Assignees
Labels
enhancement New feature or request
Milestone

Comments

@a-kramer
Copy link

Hello,
is there a way to write an indented multiline code block in a function description?
@code [...]@ does not allow line breaks in it and a possible workaround with multiple code snippets is not formatted right.

@michaelrsweet
Copy link
Owner

Sorry, not at present. I might be able to add support for markdown-style code fences (codedoc already supports backticks in place of @code ...@) so you can have something like:

/*
 * Some text leading up to an example:
 *
 * ```
 * if (foo)
 * {
 *    bar = 42;
 * }
 * ```
 */

@michaelrsweet michaelrsweet self-assigned this Nov 15, 2019
@michaelrsweet michaelrsweet added the enhancement New feature or request label Nov 15, 2019
@michaelrsweet michaelrsweet added this to the Stable milestone Nov 15, 2019
@michaelrsweet michaelrsweet changed the title pseudo code blocks in function description Support simple markdown in comments Nov 16, 2019
@michaelrsweet
Copy link
Owner

michaelrsweet commented Nov 16, 2019

OK, I'm going to add some simple markdown support beyond the current (undocumented) backtick code style:

  • Code fences with \```
  • Bulleted lists with - prefixes
  • Inline markup for *italic*, and **bold**.
  • Simple links like [title], [title](URL), and <URL>

@michaelrsweet
Copy link
Owner

[master 4fc229b] Implement emphasized text, code fences, and bullet lists (Issue #6)

@michaelrsweet
Copy link
Owner

[master 5c36e34] Add support for links in comments (Issue #6)

@a-kramer
Copy link
Author

Oh, thank you very much, amazing!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants