Re: [Doxygen-users] \include removing doxygen comments

[John D. <Joh...@gr...>]

I basically have a header that contains documentation where I reference example code.

---header.h---

/*!
 * \file header.h
 *
 * This is some documentation.  Let me demonstrate using an example.
 *
 * \include examples\demonstrate.c
 *
 * The example above should display the following.
 *
 * \code
 * Demonstrate
 * Demonstrate
 * Demonstrate
 * Demonstrate
 * \endcode
 */

---demonstrate.c---

#include <stdio.h>

/*!
 * \brief Demonstrate the function.
 * \param times The number of times.
 */
void demonstrate( int times );

int main( void )
{
  demonstrate( 4 );

  return 0;
}

void demonstrate( int times )
{
  int i;

  for ( i = 0; i < times; ++i )
    printf( "Demonstrate\n" );
}

------

I tested out the verbinclude, and it works, but the syntax highlighting is gone in the html output.  I think I'd still prefer the syntax highlighting over showing the one '!' in the comment.  It's not very important, since I can just make it a regular comment in the example file.  Maybe there is another way.

The doxy-file has the defaults except with an examples directory defined.

Thanks for the suggestions,
John D.

-----Original Message-----
From: alb...@gm... on behalf of Albert
Sent: Sat 9/25/2010 5:27 AM
To: John Dill
Cc: dox...@li...
Subject: Re: [Doxygen-users] \include removing doxygen comments
 
Hi John,

When I understand you right you have a file that you want to include
into the Doxygen generated output and this file to be included
contains also some Doxygen statements that you want to leave
untouched.
Things that come straight to my mind are:
\verbinclude
and inside the file:
\verbatim
\code
or escaping the Doxygen comment keywords.
(A small example + Doxyfile might help too)

Best Regards,

Albert

On Fri, Sep 24, 2010 at 21:46, John Dill <Joh...@gr...> wrote:
> I have a \include of an example file that contains a doxygen comment.  When I look at the generated output, the comment is not in the source code.  Is there a way to keep literal doxygen comments in the output of files included with '\include'?
>
> Thanks,
> John
>
> ------------------------------------------------------------------------------
> Start uncovering the many advantages of virtual appliances
> and start using them to simplify application deployment and
> accelerate your shift to cloud computing.
> http://p.sf.net/sfu/novell-sfdev2dev
> _______________________________________________
> Doxygen-users mailing list
> Dox...@li...
> https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>