Re: [Doxygen-develop] how to document files other than c,c++,java ?

[Christian B. <chr...@am...>]

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