pycco-docs / pycco

Literate-style documentation generator.

Home Page:https://pycco-docs.github.io/pycco/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Repeating star comment blocks

parente opened this issue · comments

Lots of code in some langs (JS, Java) have existing comments of the form:

/**
 * Yadda, yadda, yadda, ... 
 * 
 * etc.
 */

Those stars per line in the comment body end up turning into bullets when markdown sees them. A way to optionally filter out those stars as junk would be useful.

Hey Peter,

If you want to implement this, and send me a pull request, I will merge it in to master. However, I'm no longer actively maintaining and updating this code. I asked around if anyone else wanted to maintain it, but I didn't get too much interest. This project was basically a one night hack for fun that I made, and then it got a fair bit of attention out of nowhere.

Nick

I was planning to take a crack at it if I get some spare cycles.

#59 creating reference for star multiple line comments.