[Doxygen-users] Is IN_BODY_DOCS available for "Perl Module Output"?
Brought to you by:
dimitri
From: eignil <ei...@gm...> - 2013-10-21 15:34:51
|
I put some comments in the function body of c program. They can be produced normally in HTML format, but nothing for the perl module. (HIDE_IN_BODY_DOCS was set to ’NO’ ) Is this a bug or a new feature that hasn’t implemented for perl module as it is still experimental ? BTW, I used an modified version that can produce perl module with in body documents, but there are some bugs. So what is the condition of the official version to handle the perl module? Thanks very much. My test code is very simple: source code: /** *@file */ /** *@brif Inbody document test * * * *@remark end before function. */ int main(void){ /** *Comment in function body */ return 0; } Document as html: Function Documentation int main ( void ) Inbody document test Remarks end before function. Comment in function body content in DoxDocs.pm: (“Comment in function body" disapear) $doxydocs= { classes => [ ], namespaces => [ ], files => [ { name => 'test_main.c', includes => [ ], included_by => [ ], functions => { members => [ { kind => 'function', name => 'main', virtualness => 'non_virtual', protection => 'public', static => 'no', brief => {}, detailed => { doc => [ { type => 'text', content => 'Inbody document test' }, { type => 'parbreak' }, { remark => [ { type => 'text', content => 'end before function. ' } ] } ] }, type => 'int', const => 'no', volatile => 'no', parameters => [ { type => 'void' } ] } ] }, brief => {}, detailed => {} } ], groups => [ ], pages => [ ] }; 1; PS: The document of oxygen says "Doxygen allows you to put your documentation blocks practically anywhere (the exception is inside the body of a function or inside a normal C style comment block).” But in the same page before this they says “For methods and functions there is also a third type of description, the so called in bodydescription, which consists of the concatenation of all comment blocks found within the body of the method or function.” I was totally confused…. |