[GUMP-116] Promote using html in <description/> fields

• Type: Improvement
• Status: Open
• Priority: Major
• Resolution: Unresolved
• Affects Version/s: GOM-0.5
• Fix Version/s: GOM-0.5
• Component/s: Object Model (GOM)
• Assignee: Unassigned
• Reporter: Leo Simons
• Created: 07/Apr/05 04:16
• Updated: 19/Feb/12 22:10

Description

It would be cool if <description/> fields contained more useful content. For example, it might make sense to provide links to a wiki page with developer information about debugging a particular project, or links to additional build functionality a project utilizes outside of gump (like nightly build download locations). This would mean the <description/> content should get a prominent place in gump-generated docs, the GOM docs are updated to detail that one can, in fact, use HTML, and that we promote the practice in some way.

Thinking of maven POMs, their <description/> and <longDescription/> contents might need to be extended to have that kind of information relevant for developers. One could have a <developerInfo/> in addition to those, I dunno. Maybe the maven people have something plannen already :-D