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

Find UML generator #42

Open
AgostinoSturaro opened this issue Nov 27, 2013 · 1 comment
Open

Find UML generator #42

AgostinoSturaro opened this issue Nov 27, 2013 · 1 comment

Comments

@AgostinoSturaro
Copy link
Collaborator

We'd like to make good code so we can generate as much doc as possible.
If something is intuitive enough, then it takes less work to write the doc to explain it.

Also, we would rather not copy and paste the function names for each object.
There are UML generators that can parse the source code and give you at least the signature (which is a good starting poing).

I mean, this a function signature in UML, you can't copy it from the code because the types are wrote on the opposite side
functionABC(parA: Type, parB: Type): ReturnType

So you want the parser to do that, and concentrate on writing the actual description.

Candidates:
Doxygen (this is quite powerful)
WhiteStarUML (easy to use)
...

@arthurJoly
Copy link
Collaborator

I have umbrello

2013/11/27 Serpenthelm [email protected]

We'd like to make good code so we can generate as much doc as possible.
If something is intuitive enough, then it takes less work to write the doc
to explain it.

Also, we would rather not copy and paste the function names for each
object.
There are UML generators that can parse the source code and give you at
least the signature (which is a good starting poing).

I mean, this a function signature in UML, you can't copy it from the code
because the types are wrote on the opposite side
functionABC(parA: Type, parB: Type): ReturnType

So you want the parser to do that, and concentrate on writing the actual
description.

Candidates:
Doxygen (this is quite powerful)
WhiteStarUML (easy to use)
...


Reply to this email directly or view it on GitHubhttps://github.com//issues/42
.

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