[Uml-devel] [Bug 54307] documentation generation system needed

Devon NeoAndersn007 at aol.com
Tue Aug 24 00:44:16 UTC 2004


------- You are receiving this mail because: -------
You are the assignee for the bug, or are watching the assignee.
      
http://bugs.kde.org/show_bug.cgi?id=54307      




------- Additional Comments From NeoAndersn007 aol com  2004-08-23 23:36 -------
I strongly agree this should be added to Umbrello. This could be accomplished by simply having a template file like a HTML page for documentation and having Umbrello put in the data. For example:
<b>{class_name}</b>:
<list>
{foreach_function}
<li>{function_name}({function_attributes})
<list>
{function_description}
{foreach_attribute}
<li>{attribute_name}: {attribute_description}
</list>
{foreach_attribute_end}
{foreach_function_end}
</list>


could transfer to :
<b>RandomClass</b>:
<list>
<li>RandomFunction(RandomAttr1, RandomAttr2)
<list>
Does random stuff
<li>RandomAttr1: A random attribute
<li>RandomAttr2: another random attribute
</list>
<li>RandomFunction2(RandomAttr1)
<list>
Does more random stuff
<li>RandomAttr1: A random attribute
</list>
</list>

its not the best example but thats the best I could do ;-). Also this could be used to make your own documentation template and do other things too.




More information about the umbrello-devel mailing list