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

Feature request: Document both Clojure and ClojureScript #86

Closed
jdeisenberg opened this issue Mar 7, 2015 · 4 comments
Closed

Feature request: Document both Clojure and ClojureScript #86

jdeisenberg opened this issue Mar 7, 2015 · 4 comments

Comments

@jdeisenberg
Copy link

I want to generate documentation for a project that is primarily written in ClojureScript but also has some Clojure (for macros). Is there some way to get dodox to parse both sections?

@weavejester
Copy link
Owner

Codox already documents Clojure macros when creating ClojureScript documentation.

@jdeisenberg
Copy link
Author

I attempted to use Codox to create documentation for https://github.com/prismatic/dommy and set
:codox {:language :clojurescript}. The generated documentation does not appear to include any of the macros in the core.clj file. Not sure what I am doing wrong, then. (Results are at https://github.com/jdeisenberg/dommy_docs)

@weavejester
Copy link
Owner

I tried generating docs for dommy with Codox, and then looked at your results. I'm afraid I don't understand what you think is missing. The core.html file contains all five macros from core.clj.

@jdeisenberg
Copy link
Author

Ah; thank you. I see them now. Sorry about that.

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

No branches or pull requests

2 participants