You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
I find yard way better than rdoc and use it for all my ruby programs and I find default crystal documentation system very basic, so that's only natural I found about crodoc.
I have several questions :
Does crodoc supports @param, @option, @return like Yard? (I see none in examples)
Could you document what are all the keywords supported?
Could you build crodoc documentation using crodoc and host it on github pages so we could have a live demo?
Does it work with Crystal 1.7?
Do you still plan to maintain it or should I consider it abandoned?
I would like to come back to it, it's just going to take some time. The difficulty with a project like this is that you can't rely on Crystal's built in documentation generator at all, which means you need to hook into the compiler, build an AST for the code you want to document as well as collecting all of the comments, and then build the documentation from that.
I find yard way better than rdoc and use it for all my ruby programs and I find default crystal documentation system very basic, so that's only natural I found about crodoc.
I have several questions :
@param
,@option
,@return
like Yard? (I see none in examples)crystal docs
it it must use it's own command.The text was updated successfully, but these errors were encountered: