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

Parse tag strings with Markdown #139

Merged
merged 1 commit into from
Jan 21, 2015
Merged

Conversation

jugglinmike
Copy link
Contributor

Dox was just recently updated to parse Markdown in tag descriptions, but it does not (currently) do the same for the string property of tag objects. (The string property is used in place of description for tags which do not include a "type" specifier.) Here's an example usage:

/**
 * This option enforces the consistency of quotation marks used throughout
 * your code. It accepts three values: `true` if you don't want to enforce
 * one particular style but want some consistency, `"single"` if you want to
 * allow only single quotes and `"double"` if you want to allow only double
 * quotes.
 *
 * @deprecated JSHint is moving away from enforcing stylistic concerns. Check
 *             out [the JSCS project](https://github.com/jscs-dev/node-jscs)
 *             for similiar functionality.
 */

Note that I've had to special-case the alias tag. I think this makes sense, but I'd welcome input from a maintainer.

jugglinmike added a commit to jugglinmike/jshint.com that referenced this pull request Dec 26, 2014
This is blocked by a bug in the Dox library, see "Parse tag strings with
Markdown":

tj/dox#139
@jugglinmike
Copy link
Contributor Author

Is there anything more I can do to help move this along?

evindor added a commit that referenced this pull request Jan 21, 2015
@evindor evindor merged commit 1699ee0 into tj:master Jan 21, 2015
@evindor
Copy link
Collaborator

evindor commented Jan 21, 2015

Thanks and sorry it took so long :)

@evindor
Copy link
Collaborator

evindor commented Jan 21, 2015

Will make a release after we handle #143 in next few days

@jugglinmike
Copy link
Contributor Author

No problem at all. Glad I could help!

tomek-he-him pushed a commit to tomek-he-him/dox that referenced this pull request Feb 5, 2015
I find tj#139 a fantastic update. But sometimes you just need the raw string.

It seems wrong to strip HTML tags from markdown-processed strings just to bring back the
original. It's also very fragile.
tomek-he-him pushed a commit to tomek-he-him/dox that referenced this pull request Mar 23, 2015
I find tj#139 a fantastic update. But sometimes you just need the raw string.

It seems wrong to strip HTML tags from markdown-processed strings just to bring back the
original. It's also very fragile.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants