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

preserve case in doc-block? #141

Closed
softwareCobbler opened this issue Feb 24, 2022 · 2 comments
Closed

preserve case in doc-block? #141

softwareCobbler opened this issue Feb 24, 2022 · 2 comments

Comments

@softwareCobbler
Copy link

softwareCobbler commented Feb 24, 2022

I have some comments in a docblock, where some portions of the comment are forced to lowercase after a cfformat run.

The offenders are always delimited by matching <>, like

/**
* @attr parameterizedBy<SomeType>
*/

becomes

/**
* @attr parameterizedBy<sometype>
*/

It seems to only lower-case the stuff inside the <>.

Is there a flag for this maybe?
Thanks for your time.

@jcberquist
Copy link
Owner

The issue here is that <SomeType> in a docblock is being interpreted as an HTML tag - since docblocks often contain HTML for automatic documentation generation, the underlying engine is geared toward identifying that syntax as a tag. Then the tags.lowercase setting which defaults to true takes over and lowercases it. I am not sure about the best approach to this overall, but at least you can set tags.lowercase to false to prevent this from happening.

@softwareCobbler
Copy link
Author

ah, parsing as an html tag, that makes sense. thanks!

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

No branches or pull requests

2 participants