Some API description is rendered inside <pre> tags

xjsframework / xjsframework.github.io

XJS Framework website

http://xjsframework.github.io

1 stars 2 forks source link

Some API description is rendered inside <pre> tags #9

Closed ghost closed 8 years ago

ghost commented 8 years ago

http://xjsframework.github.io/api.html#/window/SourceConfigWindow#useFullWindow

The first line of the comments is always rendered as a code by the document generator, unless it's a one line comment.

mikeybanez commented 8 years ago

At the moment I did this quick fix, but I'm not sure if there are better ways to modify the doc gen for this kind of documentation. Perhaps this is sufficient.