Comment reformatting while doing reverse code eng.
101 views
Skip to first unread message
SvenS
unread,
Aug 28, 2012, 4:33:00 AM8/28/12
Reply to author
Sign in to reply to author
Forward
Sign in to forward
Delete
You do not have permission to delete messages in this group
Copy link
Report message
Show original message
Either email addresses are anonymous for this group or you need the view member email addresses permission to view the original message
to sparx-enterprise-archite...@googlegroups.com
Hi, we just came around to use EA as a tool for documentation. We use it in reverse direction (code Engineering -> Import Source Directory) for C++ code. In our project, we make heavily use of DoxyGen, which is very useful for a per class / method documentation (especially the reversing engine is much more error prone than the one of EA). So our comments look like this:
/** * This is a cool demo class which enables us to do some nice stuff. * Here we will continue with the description and we may also have * to be conformant to the following standards: * - A3980 * - A3955 * * Synopsis for usage: * Democlass class; * class.feedData(); * class.printme(); */
Now after reverse engineering, I have the following text inside the note field: This is a cool demo class which enables us to do some nice stuff. Here we will continue with the description and we may also have to be conformant to the following standards: - A3980 - A3955 Synopsis for usage: Democlass class; class.feedData(); class.printme();
So every whitespace is swallowed and now the comment looks very ugly. This is now really useless for our documentation! For doc generation, we use the very cool method to traverse the packages with JScript and generate LaTeX code from it in a very simple way. Inside the JScript I can convert formatting, but only if the whitespaces and everything else is kept as is.
So is there a possiblity to import the comments in RAW format? We can do the formatings by a script very easily, but only if we have all data available.