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

Parameters don't get processed if there is a blank line after the brief documentation #42

Closed
rhdunn opened this issue Jul 6, 2014 · 1 comment

Comments

@rhdunn
Copy link
Contributor

rhdunn commented Jul 6, 2014

Given the markdown file:

#<cldoc:test>

A test.
@a The first parameter.

The parameter is correctly documented, but given:

#<cldoc:test>

A test.

@a The first parameter.

The parameter documentation is ignored.

Both of these should associate the parameter(s) with the specified documentation.

@jessevdk
Copy link
Owner

jessevdk commented Jul 8, 2014

This is intentional. The structure of the documentation comment is very strict. This improves inter-project consistency in writing documentation comments.

@jessevdk jessevdk closed this as completed Jul 8, 2014
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