DOORS-Doxygen reporting

I could like to generate report for DXL scripts using DOxygen, i am facing problem for the variables declared in the file.

anyone have used docygen? any solutions?
ranjanasirsi - Thu Nov 24 05:55:24 EST 2011

Re: DOORS-Doxygen reporting
Mathias Mamsch - Thu Nov 24 07:28:06 EST 2011

What problems are you facing? There are some syntax issues that you need to take care off when you use doxygen, but I found it working ok.

Regards, Mathias


Mathias Mamsch, IT-QBase GmbH, Consultant for Requirement Engineering and D00RS

Re: DOORS-Doxygen reporting
ranjanasirsi - Thu Nov 24 08:08:11 EST 2011

Mathias Mamsch - Thu Nov 24 07:28:06 EST 2011
What problems are you facing? There are some syntax issues that you need to take care off when you use doxygen, but I found it working ok.

Regards, Mathias


Mathias Mamsch, IT-QBase GmbH, Consultant for Requirement Engineering and D00RS

Thanks for the reply, but for this file i wanted to generate the report, but it is giving error.
  • only if i keep the functions it is ok
  • if i have the declared variables also in the file, then it is not generating the graphs.

please let me know if you need any more information.

Thanks
Ranjana
Attachments

attachment_14729376_file.dxl

Re: DOORS-Doxygen reporting
Mathias Mamsch - Thu Nov 24 18:24:08 EST 2011

ranjanasirsi - Thu Nov 24 08:08:11 EST 2011
Thanks for the reply, but for this file i wanted to generate the report, but it is giving error.

  • only if i keep the functions it is ok
  • if i have the declared variables also in the file, then it is not generating the graphs.

please let me know if you need any more information.

Thanks
Ranjana

Can you please provide the doxygen configuration file that you are using for generating the report? What doxygen version are you using? And can you maybe attach a zip with the two results, so I can see what exactly is the problem (i.e. one report without variables, and one report with variables).
Regards, Mathias

Mathias Mamsch, IT-QBase GmbH, Consultant for Requirement Engineering and D00RS

Re: DOORS-Doxygen reporting
ranjanasirsi - Fri Nov 25 01:26:29 EST 2011

Mathias Mamsch - Thu Nov 24 18:24:08 EST 2011
Can you please provide the doxygen configuration file that you are using for generating the report? What doxygen version are you using? And can you maybe attach a zip with the two results, so I can see what exactly is the problem (i.e. one report without variables, and one report with variables).
Regards, Mathias


Mathias Mamsch, IT-QBase GmbH, Consultant for Requirement Engineering and D00RS

Thanks Mr.Mathias,

i have attached the Doxyfile, and output results in different conditions.

please check and let me know
1. The comments are given for the fucntions differently in (trail folder)
2. The original function is used in (original_code folder)
3. the variables are removed from the original file in another folder and the
4. config file
Attachments

attachment_14729532_trial.zip

Re: DOORS-Doxygen reporting
Mathias Mamsch - Fri Nov 25 09:26:26 EST 2011

ranjanasirsi - Fri Nov 25 01:26:29 EST 2011
Thanks Mr.Mathias,

i have attached the Doxyfile, and output results in different conditions.

please check and let me know
1. The comments are given for the fucntions differently in (trail folder)
2. The original function is used in (original_code folder)
3. the variables are removed from the original file in another folder and the
4. config file

The answer is as simple as stupid:

In C (which doxygen tries to parse the DXL as) you need to end each statement with a semicolon (;). In your code however your variable declararions at the start are missing the semicolon. This is a problem with doxygen, because the parser will skip invalid statements and find the end of the statement. But he does not find a ; so he reads until the end of the file skipping all your functions.

Therefore by just putting semicolon in your code:
{code}
bool Baseline_b =false; // <- semicolon here

/* ***************************************
font table definition with different font styles
***************************************/
const string fontTableBeginning = "\\deff0{\\fonttbl"; // <- semicolon here
// fonts in this part of the font table will be used for anything
// outside the Latin-1 character set
const string fontTableEnd =
"{\\f1\\fswiss\\fprq2\\fcharset0 Arial;}
{\\f2\\froman\\fprq2\\fcharset2 Symbol;}
{\\f15\\fswiss\\fprq2\\fcharset222 Arial Unicode MS;}
{\\f16\\fswiss\\fcharset238 Arial;}
}"; // <- semicolon here

Your file will be generated fine again. Note that the variables that already have semicolons show up in the file, while the others don't. I always wanted to write a Doxygen filter to reformat DXL to be more similar to C (i.e. add semicolon, add parentheses after function calls), but I never came around to do so...

Hope that helps, Regards, Mathias

Mathias Mamsch, IT-QBase GmbH, Consultant for Requirement Engineering and D00RS

Re: DOORS-Doxygen reporting
ranjanasirsi - Mon Nov 28 06:06:08 EST 2011

Mathias Mamsch - Fri Nov 25 09:26:26 EST 2011
The answer is as simple as stupid:

In C (which doxygen tries to parse the DXL as) you need to end each statement with a semicolon (;). In your code however your variable declararions at the start are missing the semicolon. This is a problem with doxygen, because the parser will skip invalid statements and find the end of the statement. But he does not find a ; so he reads until the end of the file skipping all your functions.

Therefore by just putting semicolon in your code:
{code}
bool Baseline_b =false; // <- semicolon here

/* ***************************************
font table definition with different font styles
***************************************/
const string fontTableBeginning = "\\deff0{\\fonttbl"; // <- semicolon here
// fonts in this part of the font table will be used for anything
// outside the Latin-1 character set
const string fontTableEnd =
"{\\f1\\fswiss\\fprq2\\fcharset0 Arial;}
{\\f2\\froman\\fprq2\\fcharset2 Symbol;}
{\\f15\\fswiss\\fprq2\\fcharset222 Arial Unicode MS;}
{\\f16\\fswiss\\fcharset238 Arial;}
}"; // <- semicolon here

Your file will be generated fine again. Note that the variables that already have semicolons show up in the file, while the others don't. I always wanted to write a Doxygen filter to reformat DXL to be more similar to C (i.e. add semicolon, add parentheses after function calls), but I never came around to do so...

Hope that helps, Regards, Mathias


Mathias Mamsch, IT-QBase GmbH, Consultant for Requirement Engineering and D00RS

Thanks a lot.. it works:-)