Thread: [Doxygen-develop] how to document files other than c,c++,java ?
Brought to you by:
dimitri
From: Stefan K. <ko...@im...> - 2003-11-25 16:31:45
|
hi hi, has anyone achived to document files other that c,c++,java? my system includes xml, xsl files and a dtd. For completness I would at least document the files themselfs. So I tried things like <!-- @file test.dtd @brief the test document type definition --> as well as <!-- /** * @file test.dtd * @brief the test document type definition */ --> The file appear in the section of files, but without the comment. When I follow the [code] link the /** .. */ comment is not part of the source listing. Ciao Stefan -- \|/ Stefan Kost <@ @> private business +-oOO-(_)-OOo------------------------------------------------------ - - - - - | __ Address Simildenstr. 5 HTWK Leipzig, Fb IMN, Postfach 301166 | /// 04277 Leipzig 04251 Leipzig | __ /// Germany Germany | \\\/// Phone +49341 2253538 +49341 30766101 | \__/ EMail st_kost_at_gmx.net kost_at_imn.htwk-leipzig.de | WWW www.sonicpulse.de www.imn.htwk-leipzig.de/~kost/about.html ===-=-=--=---=---------------------------------- - - - - - |
From: Christian B. <chr...@am...> - 2003-11-25 18:02:42
|
Allo Stefan! Yes, try this. Add the following: a.. /** @verbatim */ as the first line inside comment style of the = file b.. /** @endverbatim */ as the last line inside comment style of the = file This should be done without any @file and @brief. Create another file (filedescriptions.dox) and to write your file = descriptions like so: /** * @file test.dtd * @brief The test document type definition. * The long description of the file. */ /** * @file myothertest.dtd * @brief My other test document type definition. * The long description of the file. */ Include in the configuration INPUT parameter the test.dtd, = myothertest.dtd and filedescriptions.dox. I used this to document Perl script and had no problems. Salut! Christian ----- Original Message -----=20 From: Stefan Kost=20 To: dox...@li...=20 Sent: Tuesday, November 25, 2003 12:30 PM Subject: [Doxygen-develop] how to document files other than c,c++,java = ? hi hi, has anyone achived to document files other that c,c++,java? my system includes xml, xsl files and a dtd. For completness I would = at least document the files themselfs. So I tried things like <!-- @file test.dtd @brief the test document type definition --> as well as <!-- /** * @file test.dtd * @brief the test document type definition */ --> The file appear in the section of files, but without the comment. When = I follow the [code] link the /** .. */ comment is not part of the source = listing. Ciao Stefan --=20 \|/ Stefan Kost <@ @> private business +-oOO-(_)-OOo------------------------------------------------------ - = - - - - | __ Address Simildenstr. 5 HTWK Leipzig, Fb IMN, Postfach = 301166 | /// 04277 Leipzig 04251 Leipzig | __ /// Germany Germany | \\\/// Phone +49341 2253538 +49341 30766101 | \__/ EMail st_kost_at_gmx.net kost_at_imn.htwk-leipzig.de | WWW www.sonicpulse.de = www.imn.htwk-leipzig.de/~kost/about.html =3D=3D=3D-=3D-=3D--=3D---=3D---------------------------------- - - - = - - ------------------------------------------------------- This SF.net email is sponsored by: SF.net Giveback Program. Does SourceForge.net help you be more productive? Does it help you create better code? SHARE THE LOVE, and help us help YOU! Click Here: http://sourceforge.net/donate/ _______________________________________________ Doxygen-develop mailing list Dox...@li... https://lists.sourceforge.net/lists/listinfo/doxygen-develop |
From: Stefan K. <ko...@im...> - 2003-11-26 12:01:39
Attachments:
doxyfilter.pl
|
hi again, should have read some more before asking. Attached is version 0.1 of such a filter script (perl). At least file comments do work. More to come tommorow Ciao Stefan Stefan Kost wrote: > hi hi, > > has anyone achived to document files other that c,c++,java? > my system includes xml, xsl files and a dtd. For completness I would at least > document the files themselfs. So I tried things like > <!-- > @file test.dtd > @brief the test document type definition > --> > > as well as > > <!-- > /** > * @file test.dtd > * @brief the test document type definition > */ > --> > > The file appear in the section of files, but without the comment. When I follow > the [code] link the /** .. */ comment is not part of the source listing. > > Ciao > Stefan -- \|/ Stefan Kost <@ @> private business +-oOO-(_)-OOo------------------------------------------------------ - - - - - | __ Address Simildenstr. 5 HTWK Leipzig, Fb IMN, Postfach 301166 | /// 04277 Leipzig 04251 Leipzig | __ /// Germany Germany | \\\/// Phone +49341 2253538 +49341 30766101 | \__/ EMail st_kost_at_gmx.net kost_at_imn.htwk-leipzig.de | WWW www.sonicpulse.de www.imn.htwk-leipzig.de/~kost/about.html ===-=-=--=---=---------------------------------- - - - - - |
From: Stefan K. <ko...@im...> - 2003-11-27 16:12:44
Attachments:
doxyfilter.pl
|
hi again, here is an extendet version of the script. dimitri: can we define new structural commands like \fn \file \def ... when I document a dtd I would like to have \entity \element and \attlist so what I am asking for is something like \defstructcmd <structcmd> <singular> <plural> \defstructcmd entity Entity Entities /** \structcmd entity <entity-name> * \brief .... */ Ciao Stefan > hi again, > > should have read some more before asking. Attached is version 0.1 of such a > filter script (perl). At least file comments do work. More to come tommorow > > Ciao > Stefan > > Stefan Kost wrote: > >>hi hi, >> >>has anyone achived to document files other that c,c++,java? >>my system includes xml, xsl files and a dtd. For completness I would at least >>document the files themselfs. So I tried things like >><!-- >> @file test.dtd >> @brief the test document type definition >>--> >> >>as well as >> >><!-- >>/** >> * @file test.dtd >> * @brief the test document type definition >> */ >>--> >> >>The file appear in the section of files, but without the comment. When I follow >>the [code] link the /** .. */ comment is not part of the source listing. >> >>Ciao >>Stefan > > > > ------------------------------------------------------------------------ > > #!/usr/local/bin/perl > > if(!defined($ARGV[0])) { exit; } > > #print "arg : ".$ARGV[0]."\n"; > $ifilename=$ARGV[0]; > > if($ifilename=~m/.*\.dtd/) { &filter_dtd($ifilename); } > elsif($ifilename=~m/.*\.x[ms]l/) { &filter_xml($ifilename); } > else { &filter_dummy($ifilename); } > > exit; > > sub filter_dtd { > my ($fn)=@_; > > if(open(FHI,"<$fn")) { > while($line=<FHI>) { > $line=~s/\<\!\-\-/\/\*\*/g; > $line=~s/\-\-\>/\*\//g; > print $line; > } > close(FHI); > } > } > > sub filter_xml { > my ($fn)=@_; > > if(open(FHI,"<$fn")) { > while($line=<FHI>) { > $line=~s/\<\!\-\-/\/\*\*/g; > $line=~s/\-\-\>/\*\//g; > if(($line!~m/^\<\?xml/) && ($line!~m/^\<\!DOCTYPE/)) { > print $line; > } > } > close(FHI); > } > } > > sub filter_dummy { > my ($fn)=@_; > > if(open(FHI,"<$fn")) { > while($line=<FHI>) { > print $line; > } > close(FHI); > } > } -- \|/ Stefan Kost <@ @> private business +-oOO-(_)-OOo------------------------------------------------------ - - - - - | __ Address Simildenstr. 5 HTWK Leipzig, Fb IMN, Postfach 301166 | /// 04277 Leipzig 04251 Leipzig | __ /// Germany Germany | \\\/// Phone +49341 2253538 +49341 30766101 | \__/ EMail st_kost_at_gmx.net kost_at_imn.htwk-leipzig.de | WWW www.sonicpulse.de www.imn.htwk-leipzig.de/~kost/about.html ===-=-=--=---=---------------------------------- - - - - - |
From: Dimitri v. H. <di...@st...> - 2003-11-30 11:48:31
|
On Thu, Nov 27, 2003 at 05:11:28PM +0100, Stefan Kost wrote: > hi again, > > here is an extendet version of the script. > > dimitri: can we define new structural commands like \fn \file \def ... > when I document a dtd I would like to have \entity \element and \attlist > > so what I am asking for is something like > > \defstructcmd <structcmd> <singular> <plural> > \defstructcmd entity Entity Entities > > /** \structcmd entity <entity-name> > * \brief .... > */ This is not possible now, but for the things you want to do it is a nice feature to have. Maybe you can help me implement it. Regards, Dimitri |