Welcome to Telelogic Product Support
  Home Downloads Knowledgebase Case Tracking Licensing Help Telelogic Passport
Telelogic DOORS (steve huntington)
Decrease font size
Increase font size
Topic Title: DXL code documentation.
Topic Summary: Auto documentation.
Created On: 23-Jun-2008 10:15
Status: Post and Reply
Linear : Threading : Single : Branch
Search Topic Search Topic
Topic Tools Topic Tools
Quick Reply Quick Reply
Subscribe to this topic Subscribe to this topic
E-mail this topic to someone. E-mail this topic
Bookmark this topic Bookmark this topic
View similar topics View similar topics
View topic in raw text format. Print this topic.
 23-Jun-2008 10:15
User is offline View Users Profile Print this message


Shyam Sundar

Posts: 8
Joined: 26-Jul-2006

Hi all,
Is there any tool, like Doxygen, that automatically creates the document for DXL code based on the code comments?
Kindly post if any one has hit across any such thing.

Thank you.

Regards,
Shyam

-------------------------
Regards,
Shyam
Report this to a Moderator Report this to a Moderator
 23-Jun-2008 11:39
User is offline View Users Profile Print this message


Reik Schroeder

Posts: 361
Joined: 28-Jul-2003

Hi Shyam,

you can use Doxygen for commenting the code.
The only thing you need to do, is to assure that dxl is handled as C-code.

The easiest way of achieving that is to modify in "util.cpp" (in source code of doxygen) the function "SrcLangExt getLanguageFromFileName(const QCString fileName)" that it will always return "SrcLangExt_ObjC".

Then Doxygen will handle any source code as c code and you can use the doxygen comments within your DXL code.

Hope that hepls you,
Greetings
Reik

-------------------------
Evosoft GmbH
for Siemens Industry Sector


Berlin, Germany
Report this to a Moderator Report this to a Moderator
 25-Jun-2008 05:49
User is offline View Users Profile Print this message


Shyam Sundar

Posts: 8
Joined: 26-Jul-2006

Thank you Riek. I shall have a look at it.

-------------------------
Regards,
Shyam
Report this to a Moderator Report this to a Moderator
 26-Jun-2008 16:36
User is offline View Users Profile Print this message


Richard Good

Posts: 152
Joined: 22-Mar-2005

Hi Reik,
Great idea, but it left me shaking my head in confusion - I got it to work for the examples in the help file, but there were no ".c" files - I changed the extension of a random ".dxl" file to ".c" and then ".cpp" and added comments in the styles described in the help file, but no documentation appeared for my dxl. If you have this working then it would be immensley helpful if you posted your slightly modified "Doxygen.exe" file an example configuration file and an example code file that generates documentation - I suspect that you have to write dxl in c style using semi colons etc to generate anything - could be wrong though! You may also have to read and understand and tweak the 500 odd configuration settings, these however will probably be almost standard (except for input and output files) for all dxl documentation

-------------------------
Regards,

Richard Good
Report this to a Moderator Report this to a Moderator
 14-Jul-2008 12:38
User is offline View Users Profile Print this message


Reik Schroeder

Posts: 361
Joined: 28-Jul-2003

Hi Richard,

attached you will find the zipped executabe of doxygen ....

You can find an example dxl file
here

As you may see, we are using a Clearcase trigger to insert version information into @file tag.

A default configuration file can be generated using
doxygen -g
Then you may change the paramters to your needs.

hope that helps you to get started

Greetings
Reik

doxygen.zip
doxygen.zip  (1989 KB)



-------------------------
Evosoft GmbH
for Siemens Industry Sector


Berlin, Germany
Report this to a Moderator Report this to a Moderator
Statistics
20925 users are registered to the Telelogic DOORS forum.
There are currently 1 users logged in.
The most users ever online was 15 on 15-Jan-2009 at 16:36.
There are currently 0 guests browsing this forum, which makes a total of 1 users using this forum.
You have posted 0 messages to this forum. 0 overall.

FuseTalk Standard Edition v3.2 - © 1999-2009 FuseTalk Inc. All rights reserved.