doc_tags.coffee not documented by groc

[Fresheyeball]

It sure would be nice to learn about all the documentation tags groc supports. Too bad its undocumented. Here for example: http://nevir.github.io/groc/index.html

[sjorek]

Did look into the table of contents ?!?

Am 15.10.2013 um 05:30 schrieb Isaac Shapira [email protected]:

It sure would be nice to learn about all the documentation tags groc supports. Too bad its undocumented. Here for example: http://nevir.github.io/groc/index.html

—
Reply to this email directly or view it on GitHub.

[sjorek]

Damned - sorry you're right. It's missing … does this one help you out: http://sjorek.github.io/groc/doc_tags.html ?

Am 15.10.2013 um 05:30 schrieb Isaac Shapira [email protected]:

It sure would be nice to learn about all the documentation tags groc supports. Too bad its undocumented. Here for example: http://nevir.github.io/groc/index.html

—
Reply to this email directly or view it on GitHub.

[Fresheyeball]

Yes! Thank you! I wanted to start using doc_tags, but had no idea Groc supported them until I came across it in source.

[mabogunje]

Hey guys,
I've seen the doc_tags documentation at: : http://sjorek.github.io/groc/doc_tags.html, and started using them in my documentation. But it looks like not all listed "supported tags" are fully supported to render as shown in the examples.

The sections also don't seem to show up at all. Like with the @author tag generating an Authors section, and the @see tag having a Reference section etc. Am I just using the tags wrong? What is actually currently supported?

[sjorek]

You’re looking at the documentation of my (@sjorek) fork, which has many (and large) patches (https://github.com/sjorek/groc/compare) applied and should be considered as highly experimental … http://nevir.github.io/groc/ (@nevir & @kmdavis) is the official documentation. I guess, officially there is only very little or partially no support for most doc_tags at all. Feel free to comment on my fork or to submit pull-requests. Remember you can always run groc on its own sources to render its documentation …

Cheers.

Hey guys,
I've seen the doc_tags documentation at: : http://sjorek.github.io/groc/doc_tags.html, and started using them in my documentation. But it looks like not all listed "supported tags" are fully supported to render as shown in the examples.

The sections also don't seem to show up at all. Like with the @author tag generating an Authors section, and the @see tag having a Reference section etc. Am I just using the tags wrong? What is actually currently supported?

—
Reply to this email directly or view it on GitHub.

[sjorek]

@mabogunje:
| “ … But it looks like not all listed "supported tags" are fully supported to render as shown in the examples.”

You're right … as my documentation says: “A list of doctag-candidates” … 😏