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

MonkeyDoc and #Import + @return #489

Open
D-a-n-i-l-o opened this issue Sep 4, 2019 · 1 comment
Open

MonkeyDoc and #Import + @return #489

D-a-n-i-l-o opened this issue Sep 4, 2019 · 1 comment

Comments

@D-a-n-i-l-o
Copy link
Contributor

D-a-n-i-l-o commented Sep 4, 2019

If you use the following MonkeyDoc example, the line with '#Import' is removed from the docs output:

@example
#Import "<std>"
@end

If you use '\#' instead, the '\' (backslash) is actually dispayed in the docs.

@example
\#Import "<std>"
@end

As an example see the documentation for std.memory.DataBuffer.New() ( DataBuffer )

@D-a-n-i-l-o D-a-n-i-l-o changed the title MonkeyDoc and #Import MonkeyDoc and #Import + @return Sep 4, 2019
@D-a-n-i-l-o
Copy link
Contributor Author

D-a-n-i-l-o commented Sep 4, 2019

Additionally: All @return lines are missing in the output.

See for example: std.memory.DataBuffer.PeekShort() -> @param is included, @return is missing in the output docs.

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

1 participant