Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Some questions #2

Open
noraj opened this issue Mar 12, 2023 · 3 comments
Open

Some questions #2

noraj opened this issue Mar 12, 2023 · 3 comments
Labels
question Further information is requested

Comments

@noraj
Copy link

noraj commented Mar 12, 2023

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 :

  1. Does crodoc supports @param, @option, @return like Yard? (I see none in examples)
  2. Could you document what are all the keywords supported?
  3. Could you build crodoc documentation using crodoc and host it on github pages so we could have a live demo?
  4. Does it work with Crystal 1.7?
  5. Do you still plan to maintain it or should I consider it abandoned?
  6. How to use it? The section is blank https://github.com/watzon/crodoc#usage, it doesn't override crystal docs it it must use it's own command.
@watzon
Copy link
Owner

watzon commented Mar 13, 2023

This was an idea for a project more than an actual project. It is currently completely non-functional.

@watzon watzon added the question Further information is requested label Mar 13, 2023
@noraj
Copy link
Author

noraj commented Mar 13, 2023

It was a good idea then 🙂

@watzon
Copy link
Owner

watzon commented Mar 13, 2023

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
question Further information is requested
Projects
None yet
Development

No branches or pull requests

2 participants