Doxygen for Scala? ScalaDoc Diagrams?

[Seyed H. HAERI (Hossein)]

Dear all,

Is there any equivalent for Doxygen in the Scala ecosystem? Is there a good tutorial for how to get diagrams generated through ScalaDoc?

TIA,

--Hossein

--------------------------------------------------------------------------------------------------------------

Seyed H. HAERI (Hossein)

Research Assistant
Institute for Software Systems (STS)
Technical University of Hamburg (TUHH)
Hamburg, Germany

ACCU - Professionalism in programming - http://www.accu.org/
--------------------------------------------------------------------------------------------------------------

[Vlad Ureche]

Hi Hossein,

Here are two resources for creating scaladoc diagrams:

• getting diagrams in your scaladoc: http://stackoverflow.com/questions/13435474/how-to-generate-type-hierarchy-diagrams-with-scaladoc
• refining diagrams in your scaladoc: http://www.slideshare.net/VladUreche/scaladoc-reflection

It would be awesome if somebody would consolidate these resources into a docs.scala-lang.org page...

HTH,
Vlad

--
You received this message because you are subscribed to the Google Groups "scala-user" group.
To unsubscribe from this group and stop receiving emails from it, send an email to scala-user+...@googlegroups.com.
For more options, visit https://groups.google.com/d/optout.

[Seyed H. HAERI (Hossein)]

Thank you Vlad. That looks like a good starting point. :)

--

[Seyed H. HAERI (Hossein)]

Dear Vlad,

When I use the -diagrams option, I get the following error for a good number of my entities (other than _root_):

Graphviz dot encountered an error when generating the diagram for: ...

I'm afraid the -diagrams-debug option isn't informative at all:

 

Diagram generation running time breakdown:

diagrams model filtering: no stats gathered
diagrams model generation: no stats gathered
dot diagram generation: no stats gathered
dot process runnning: no stats gathered
svg processing: no stats gathered
Broken images: 0

Fixed images: 0

I even manually installed Graphviz, but, nothing changed. Any idea?

TIA,

--Hossein

On 10 July 2014 16:42, Vlad Ureche <vlad....@gmail.com> wrote:

--

[Vlad Ureche]

The diagnostics suggest no diagram was generated at all :))
Please run with both `-diagrams` and `-diagrams-debug` together, then you should get the output.

HTH,

Vlad

[Seyed H. HAERI (Hossein)]

OK, that's much better. :) It helped me realise that my dot.exe wasn't in the path. Having added that, I no longer get dot error messages. Despite that, and even though I've got "@contentDiagram and @inheritanceDiagram" in my stuff, I don't still get any diagrams. What then?

[Seyed H. HAERI (Hossein)]

Sorry, I do get them. I had only missed them. Thanks! :)

[Vlad Ureche]

2014-07-11 2:03 GMT+03:00 Seyed H. HAERI (Hossein) <hossei...@gmail.com>:

Sorry, I do get them. I had only missed them. Thanks! :)

Hossein, I'm really glad to hear that. Would you be willing to write a short blog post / page / description about how you got diagrams working?

Cheers,

Vlad

[Seyed H. HAERI (Hossein)]

Dear Vlad,

Hossein, I'm really glad to hear that. Would you be willing to write a short blog post / page / description about how you got diagrams working? 

Thank you for your support. In fact, given my beginner level on the topic, I don't think I'm in a position to write a blog post. (And, I don't personally blog BTW.) But, this list is in fact indexed to the public. And, I don't think in a blog post I would have sprinkled much more than what's already here anyway. :p

Cheers,

--Hossein