On 12/25/12 11:10 AM, Sean Silva wrote:> UML diagrams can be really helpful for explaining how a piece of code > works (such as the diagrams in your klang project on github). > > The main reason I don't draw them is that I haven't found convenient > tools to use which integrate well with my workflow. Doxygen produces > class diagrams, but I would really like to have something which > produces sequence diagrams (such as > <http://journeyer.github.com/klang/sequence_diagram_llvm.html>). What > tools did you use to generate the diagrams for the klang > documentation?At the bottom Created using<a href="http://sphinx.pocoo.org/ <view-source:http://sphinx.pocoo.org/>">Sphinx</a> 1.1.3.
On Mon, Dec 24, 2012 at 9:19 PM, "C. Bergström" <cbergstrom at pathscale.com> wrote:> At the bottom > > Created using<a href="http://sphinx.pocoo.org/ > <view-source:http://sphinx.pocoo.org/>">Sphinx</a> 1.1.3.That is the documentation generator which creates generate the HTML page from the .rst files (similar to how LLVM and Clang's `docs/*.rst` files get turned into `{,clang.}llvm.org/docs/*.html`), and is not related to the sequence diagrams (which are just images as far as Sphinx is concerned). (As it happens, I'm actually the one that set up the Sphinx infrastructure for klang (see <https://github.com/Journeyer/klang/pull/2>)). -- Sean Silva
Journeyer J. Joh
2012-Dec-25 08:53 UTC
[LLVMdev] [cfe-dev] Do you use UML utility programs?
Hi Sean Silva and people on our list,>> What tools did you use to generate the diagrams for the klang documentation?I use StarUML. ( http://staruml.sourceforge.net/en/ ) I mentioned about this earlier before on this mail-list. It's a Windows only application and free software. It is good SW. But development is stopped since long ago. The product was originally a commercial one. But all of a sudden the company has been shutdown and the product is released as a free and open source. Please don't get me wrong I am not related with this SW. I am only a user. Sincerely Journeyer 2012/12/25 Sean Silva <silvas at purdue.edu>:> On Mon, Dec 24, 2012 at 9:19 PM, "C. Bergström" > <cbergstrom at pathscale.com> wrote: >> At the bottom >> >> Created using<a href="http://sphinx.pocoo.org/ >> <view-source:http://sphinx.pocoo.org/>">Sphinx</a> 1.1.3. > > That is the documentation generator which creates generate the HTML > page from the .rst files (similar to how LLVM and Clang's `docs/*.rst` > files get turned into `{,clang.}llvm.org/docs/*.html`), and is not > related to the sequence diagrams (which are just images as far as > Sphinx is concerned). (As it happens, I'm actually the one that set up > the Sphinx infrastructure for klang (see > <https://github.com/Journeyer/klang/pull/2>)). > > -- Sean Silva-- ---------------------------------------- Journeyer J. Joh o o s a p r o g r a m m e r a t g m a i l d o t c o m ----------------------------------------