[prev in list] [next in list] [prev in thread] [next in thread]
List: doxygen-users
Subject: Re: [Doxygen-users] \include removing doxygen comments
From: "John Dill" <John.Dill () greenfieldeng ! com>
Date: 2010-09-27 19:47:43
Message-ID: CD873D5C230AC04B9F3C4934376CEDDC0100DF () green-5 ! greenfieldengineering ! local
[Download RAW message or body]
--===============7919686482190051637==
Content-class: urn:content-classes:message
Content-Type: multipart/alternative;
boundary="----_=_NextPart_001_01CB5E7D.12FE1C19"
This is a multi-part message in MIME format.
I think this should work for me. It works on the example I was working on, and I \
don't really have a need to strip out the comments from the header source.
Thanks,
John D.
-----Original Message-----
From: albert.v.d.meer@gmail.com on behalf of Albert
Sent: Mon 9/27/2010 2:27 PM
To: Dimitri Van Heesch
Cc: John Dill; doxygen-users@lists.sourceforge.net
Subject: Re: [Doxygen-users] \include removing doxygen comments
This looks, I thin like Jon wants.
@Dimitri: I should not only have scanned the documentation but I
should also have read and studied it ( :-) )
Best regards,
Albert
On Mon, Sep 27, 2010 at 20:10, Dimitri Van Heesch <doxygen@gmail.com> wrote:
> Hi,
>
> This should already be controllable via STRIP_CODE_COMMENTS in the config file.
>
> Regards,
> Dimitri
>
> On Sep 27, 2010, at 19:31 , Albert wrote:
>
> > Hi Jon,
> >
> > I see what you mean. I've been playing around a bit but have not been
> > able to find a solution. The \include and also the \code command strip
> > away the Doxygen comment not the normal comment.
> > I don't know why this option has been chosen, maybe it ha to do
> > something with parsing the files, but I would have expected that all
> > the comment would have been left in place.
> > I think this requires an extra option or a change in the behavior of the code
> >
> > best regards,
> >
> > Albert
> >
> > On Mon, Sep 27, 2010 at 15:31, John Dill <John.Dill@greenfieldeng.com> wrote:
> > >
> > > 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: albert.v.d.meer@gmail.com on behalf of Albert
> > > Sent: Sat 9/25/2010 5:27 AM
> > > To: John Dill
> > > Cc: doxygen-users@lists.sourceforge.net
> > > 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 <John.Dill@greenfieldeng.com>
> > > 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
> > > > Doxygen-users@lists.sourceforge.net
> > > > https://lists.sourceforge.net/lists/listinfo/doxygen-users
> > > >
> > > >
> > >
> > >
> >
> > ------------------------------------------------------------------------------
> > 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
> > Doxygen-users@lists.sourceforge.net
> > https://lists.sourceforge.net/lists/listinfo/doxygen-users
>
>
[Attachment #3 (text/html)]
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 3.2//EN">
<HTML>
<HEAD>
<META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=iso-8859-1">
<META NAME="Generator" CONTENT="MS Exchange Server version 6.5.7654.12">
<TITLE>RE: [Doxygen-users] \include removing doxygen comments</TITLE>
</HEAD>
<BODY>
<!-- Converted from text/plain format -->
<BR>
<P><FONT SIZE=2>I think this should work for me. It works on the example I was \
working on, and I don't really have a need to strip out the comments from the header \
source.<BR> <BR>
Thanks,<BR>
John D.<BR>
<BR>
-----Original Message-----<BR>
From: albert.v.d.meer@gmail.com on behalf of Albert<BR>
Sent: Mon 9/27/2010 2:27 PM<BR>
To: Dimitri Van Heesch<BR>
Cc: John Dill; doxygen-users@lists.sourceforge.net<BR>
Subject: Re: [Doxygen-users] \include removing doxygen comments<BR>
<BR>
This looks, I thin like Jon wants.<BR>
<BR>
@Dimitri: I should not only have scanned the documentation but I<BR>
should also have read and studied it ( :-) )<BR>
<BR>
Best regards,<BR>
<BR>
Albert<BR>
<BR>
On Mon, Sep 27, 2010 at 20:10, Dimitri Van Heesch <doxygen@gmail.com> \
wrote:<BR> > Hi,<BR>
><BR>
> This should already be controllable via STRIP_CODE_COMMENTS in the config \
file.<BR> ><BR>
> Regards,<BR>
> Dimitri<BR>
><BR>
> On Sep 27, 2010, at 19:31 , Albert wrote:<BR>
><BR>
>> Hi Jon,<BR>
>><BR>
>> I see what you mean. I've been playing around a bit but have not been<BR>
>> able to find a solution. The \include and also the \code command strip<BR>
>> away the Doxygen comment not the normal comment.<BR>
>> I don't know why this option has been chosen, maybe it ha to do<BR>
>> something with parsing the files, but I would have expected that all<BR>
>> the comment would have been left in place.<BR>
>> I think this requires an extra option or a change in the behavior of the \
code<BR> >><BR>
>> best regards,<BR>
>><BR>
>> Albert<BR>
>><BR>
>> On Mon, Sep 27, 2010 at 15:31, John Dill <John.Dill@greenfieldeng.com> \
wrote:<BR> >>><BR>
>>> I basically have a header that contains documentation where I \
reference<BR> >>> example code.<BR>
>>><BR>
>>> ---header.h---<BR>
>>><BR>
>>> /*!<BR>
>>> * \file header.h<BR>
>>> *<BR>
>>> * This is some documentation. Let me demonstrate using an example.<BR>
>>> *<BR>
>>> * \include examples\demonstrate.c<BR>
>>> *<BR>
>>> * The example above should display the following.<BR>
>>> *<BR>
>>> * \code<BR>
>>> * Demonstrate<BR>
>>> * Demonstrate<BR>
>>> * Demonstrate<BR>
>>> * Demonstrate<BR>
>>> * \endcode<BR>
>>> */<BR>
>>><BR>
>>> ---demonstrate.c---<BR>
>>><BR>
>>> #include <stdio.h><BR>
>>><BR>
>>> /*!<BR>
>>> * \brief Demonstrate the function.<BR>
>>> * \param times The number of times.<BR>
>>> */<BR>
>>> void demonstrate( int times );<BR>
>>><BR>
>>> int main( void )<BR>
>>> {<BR>
>>> demonstrate( 4 );<BR>
>>><BR>
>>> return 0;<BR>
>>> }<BR>
>>><BR>
>>> void demonstrate( int times )<BR>
>>> {<BR>
>>> int i;<BR>
>>><BR>
>>> for ( i = 0; i < times; ++i )<BR>
>>> printf( "Demonstrate\n" );<BR>
>>> }<BR>
>>><BR>
>>> ------<BR>
>>><BR>
>>> I tested out the verbinclude, and it works, but the syntax highlighting \
is<BR> >>> gone in the html output. I think I'd still prefer the syntax \
highlighting<BR> >>> over showing the one '!' in the comment. It's not very \
important, since I<BR> >>> can just make it a regular comment in the example \
file. Maybe there is<BR> >>> another way.<BR>
>>><BR>
>>> The doxy-file has the defaults except with an examples directory \
defined.<BR> >>><BR>
>>> Thanks for the suggestions,<BR>
>>> John D.<BR>
>>><BR>
>>> -----Original Message-----<BR>
>>> From: albert.v.d.meer@gmail.com on behalf of Albert<BR>
>>> Sent: Sat 9/25/2010 5:27 AM<BR>
>>> To: John Dill<BR>
>>> Cc: doxygen-users@lists.sourceforge.net<BR>
>>> Subject: Re: [Doxygen-users] \include removing doxygen comments<BR>
>>><BR>
>>> Hi John,<BR>
>>><BR>
>>> When I understand you right you have a file that you want to include<BR>
>>> into the Doxygen generated output and this file to be included<BR>
>>> contains also some Doxygen statements that you want to leave<BR>
>>> untouched.<BR>
>>> Things that come straight to my mind are:<BR>
>>> \verbinclude<BR>
>>> and inside the file:<BR>
>>> \verbatim<BR>
>>> \code<BR>
>>> or escaping the Doxygen comment keywords.<BR>
>>> (A small example + Doxyfile might help too)<BR>
>>><BR>
>>> Best Regards,<BR>
>>><BR>
>>> Albert<BR>
>>><BR>
>>> On Fri, Sep 24, 2010 at 21:46, John Dill \
<John.Dill@greenfieldeng.com><BR> >>> wrote:<BR>
>>>> I have a \include of an example file that contains a doxygen \
comment.<BR> >>>> When I look at the generated output, the comment is \
not in the source code.<BR> >>>> Is there a way to keep literal doxygen \
comments in the output of files<BR> >>>> included with '\include'?<BR>
>>>><BR>
>>>> Thanks,<BR>
>>>> John<BR>
>>>><BR>
>>>><BR>
>>>> ------------------------------------------------------------------------------<BR>
>>>> Start uncovering the many advantages of virtual appliances<BR>
>>>> and start using them to simplify application deployment and<BR>
>>>> accelerate your shift to cloud computing.<BR>
>>>> <A HREF="http://p.sf.net/sfu/novell-sfdev2dev">http://p.sf.net/sfu/novell-sfdev2dev</A><BR>
>>>> _______________________________________________<BR>
>>>> Doxygen-users mailing list<BR>
>>>> Doxygen-users@lists.sourceforge.net<BR>
>>>> <A HREF="https://lists.sourceforge.net/lists/listinfo/doxygen-users">https://lists.sourceforge.net/lists/listinfo/doxygen-users</A><BR>
>>>><BR>
>>>><BR>
>>><BR>
>>><BR>
>><BR>
>> ------------------------------------------------------------------------------<BR>
>> Start uncovering the many advantages of virtual appliances<BR>
>> and start using them to simplify application deployment and<BR>
>> accelerate your shift to cloud computing.<BR>
>> <A HREF="http://p.sf.net/sfu/novell-sfdev2dev">http://p.sf.net/sfu/novell-sfdev2dev</A><BR>
>> _______________________________________________<BR>
>> Doxygen-users mailing list<BR>
>> Doxygen-users@lists.sourceforge.net<BR>
>> <A HREF="https://lists.sourceforge.net/lists/listinfo/doxygen-users">https://lists.sourceforge.net/lists/listinfo/doxygen-users</A><BR>
><BR>
><BR>
<BR>
</FONT>
</P>
</BODY>
</HTML>
[Attachment #4 (--===============7919686482190051637==)]
------------------------------------------------------------------------------
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
Doxygen-users@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/doxygen-users
[prev in list] [next in list] [prev in thread] [next in thread]
Configure |
About |
News |
Add a list |
Sponsored by KoreLogic