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 <para>, <example>, <code> tags #2

Open
fraguada opened this issue Nov 14, 2017 · 6 comments
Open

Support <para>, <example>, <code> tags #2

fraguada opened this issue Nov 14, 2017 · 6 comments

Comments

@fraguada
Copy link

I've been pleasantly surprised about the utility of this repo. I've used it to make the reference to my class library here. It would be great to extend this to support <para>, <example>, and <code> tags. Perhaps all tags for that matter.

For example, I wanted to have the summary on different lines, and added a code example to this object: https://github.com/mcneel/ThreeLib/blob/master/src/THREE/Scenes/Scene.cs#L7-L21. These are not picked up by the VSDocParser.

I will attempt to extend the functionality when I get a change. Thanks for a nice tool!

@neuecc
Copy link
Owner

neuecc commented Nov 15, 2017

Thank you for use!
Okay, I'll think about how to format.

@patrickweegen
Copy link

I would suggest to generate an own file for each member where those tags can be displayed.
Something like microsoft is dooing it: List.Find(Predicate) Method

@KonH
Copy link
Contributor

KonH commented Feb 23, 2018

<para> tag will be very helpfull, long comment text is hard to read currently.
@neuecc
If you accept me to help with it, I can do it (or maybe make pull-request anyway when find time to discover it deeply).

@enkelmedia
Copy link

I've work on support for "example"-tags, it not ready to be a PR but if @neuecc would like to I'll all open to create one.

https://github.com/enkelmedia/MarkdownGenerator/tree/method-details

@enkelmedia
Copy link

@neuecc To update on this one.

I've made quite some changes to the way to render methods and adding support for example and code, also adding support for code inside summery. These changes live in my "dev"-branch

https://github.com/enkelmedia/MarkdownGenerator/tree/dev

I could try to clean up the code and create a pull request but only you would consider a merge?

@neuecc
Copy link
Owner

neuecc commented May 28, 2019

@enkelmedia yes, if you send PR, I'll merge it.

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

5 participants