neuecc/MarkdownGenerator

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

fraguada opened this issue · 6 comments

fraguada commented

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 commented

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

patrickweegen commented

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 commented

<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 commented

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

  • 👍1
enkelmedia commented

@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 commented

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