ianxm / haxeumlgen Goto Github PK
View Code? Open in Web Editor NEWDynamically generates UML diagrams for haXe projects
License: BSD 2-Clause "Simplified" License
haxeumlgen's Introduction
HaxeUmlGen generates class diagrams dynamically for a haXe project. HaxeUmlGen can run in two modes. It can draw diagram images, or it can generate XMI projects which can be imported into UML tools. To generate images, graphviz must be installed and the binary must be added to the path. Graphviz is a free program that can be found at http://www.graphviz.org. USAGE HaxeUmlGen uses the xml file created when the -xml flag is passed in to the haxe compiler. It can be run directly from haxelib. haxelib run HaxeUmlGen MODE XMLFILE where MODE is "dot" to generate images or "xmi" to generate an xmi project XMLFILE is the file that the haxe compiler created For example, to generate diagram images of myproject, compile with haxe -neko myproject.n -xml myproject.xml MyProject.hx then generate diagrams with haxelib run haxeumlgen dot myproject.xml That will create a files called [packagename].png for each package in the same directory as myproject.xml An XMI project can be generated with haxelib run haxeumlgen xmi myproject.xml That will create a file called myproject-xmi.xml in the same directory as myproject.xml The output directory can be changed with the --outdir command line parameter. Foreground and background colors for the images can be changed with -f COLOR and -b COLOR, respectively. COLOR should be a six character hex code, like color specifications for html. Don't quote colors or prefix with a sharp (#). All command line options can be listed with neko haxeumlgen --help CHXDOC ChxDoc is a source documentation tool written by Russell Weir. HaxeUmlGen can be integrated with chxdoc by following the instructions found in the chxdoc directory.
haxeumlgen's People
Contributors
Stargazers
Watchers
haxeumlgen's Issues
Unique uml graph (unique image) for a whole project
I would like to create one unique uml graph for a whole project.
It seems possible, but I don't know where I have to make changes in haxeumlgen code. Can you give me some help to understand it ?
In the same way, is it possible to:
- exclude some specific classes or packages from the uml graph ?
- hide properties and methods from the uml graph to display only the inheritance between classes (when graphs are too big)
At last, is it possible to create parameters of haxeumlgen for these different cases ?
Thanks for your help
haxe 3 support
Error while generation
Hello,
I'm trying to generate UMl diagrams for my project and I get this error message
I:\Algebria\Utils>haxelib run HaxeumlGen dot Utils.xml
HaxeUmlGen v0.1.6 - (c) 2011-2012 Ian Martins, Daniel Kuschny
Generated Diagram for Package: flash.text
HaxeUmlGen Error: Invalid field access : name
stack: [FilePos(null,umlgen/model/ClassModel.hx,177), FilePos(null,/usr/lib/haxe/std/Lambda.hx,99), FilePos(null,umlgen/model/ClassModel.hx,177), FilePos(null,umlgen/model/ClassModel.hx,165), FilePos(null,umlgen/model/ClassModel.hx,131), FilePos(null,/usr/lib/haxe/std/List.hx,218), FilePos(null,umlgen/model/ClassModel.hx,131), FilePos(null,umlgen/model/ClassModel.hx,106), FilePos(null,umlgen/handler/GraphvizOutputHandler.hx,180), FilePos(null,umlgen/HaxeUmlGen.hx,349), FilePos(null,umlgen/HaxeUmlGen.hx,120)]
I have absolutly no idea were this error comes from.
Is it also possible to restrict diagrams generation to certain classes/packages?
Thank you for your help.
Error
Unknown option error on Windows
On Windows7, in cmd console, or in cygwin console, I get the following error:
E:\Projects\MyProject>haxelib run HaxeUmlGen MyProject.xml
HaxeUmlGen Error: Unknown option: E:\Projects\MyProject/
stack: [FilePos(null,umlgen/HaxeUmlGen.hx,186), FilePos(null,umlgen/HaxeUmlGen.hx,94)]
Works fine executing the same on Linux. It looks to be an issue with Windows style file paths.
XML Generation fails
Hi! I am trying to generate the XML file from my Haxe Javascript project and it fails whenever I have an imported API library (e.g.) js.Lib:
This is the command:
haxe -cp DVCore/src -lib hxjson2 -xml mygraph.xml --main Main
and this is the error i get:
You can't access the js package with current compilation flags (for js.Lib).
I tried adding #if js compilation flags, but it fails because the objects that use the imported types fail. Any ideas how I can create an XML output when I am using API imports?
Thanks!
Sergio
Generate XMI for UML Tools
Currently only a uml diagram using graphviz is possible. It would be awesome if there would be an option for generating XMI Files. (http://de.wikipedia.org/wiki/XML_Metadata_Interchange)
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.